cytomining / profiling-handbook

Image-based Profiling Handbook
https://cytomining.github.io/profiling-handbook/
Creative Commons Zero v1.0 Universal
9 stars 8 forks source link

Handbook discrepancy: <top-level>/<batch> vs. <top-level>/images/<batch> #71

Open shntnu opened 2 years ago

shntnu commented 2 years ago

The Cell Painting Gallery and the Profiling Handbook specify different nesting structures for images.

Should we try to resolve it by modifying the handbook to suit? Note that when deciding the folder structure for the gallery, we did start with the handbook structure and then modified it because we felt this new structure (used in Cell Painting Gallery) made more sense.

It's not mandatory to resolve this discrepancy because it can easily be handled during sync.

Cell Painting Gallery: https://github.com/broadinstitute/cellpainting-gallery/blob/0d63bf7db1c5db70675de37fe18577e3cb537e3c/folder_structure.md#images-folder-structure

    └── <top-level>
        └── images
        │   ├── YYYY_MM_DD_<batch-name>
        │   │   ├── illum
        │   │   │   ├── <plate-name>
        │   │   │   │   ├── <plate-name>_Illum<Channel>.npy
        │   │   │   │   └── <plate-name>_Illum<Channel>.npy
        │   │   │   └── <plate-name>
        │   │   └── images
        │   │       ├── <full-plate-name>
        │   │       └── <full-plate-name>
        │   └── YYYY_MM_DD_<batch-name>
        └── workspace

Profiling Handbook: https://github.com/cytomining/profiling-handbook/blob/2c4dc1ba62ef5141ceb789494d450f6ba14fe05e/06-appendix.md#directory-structure

    └── <top-level>
        ├── YYYY_MM_DD_<batch-name>
        │   ├── illum
        │   │   ├── <plate-name>
        │   │   │   ├── <plate-name>_Illum<Channel>.npy
        │   │   │   └── <plate-name>_Illum<Channel>.npy
        │   │   └── <plate-name>
        │   └── images
        │       ├── <full-plate-name>
        │       └── <full-plate-name>
        └── YYYY_MM_DD_<batch-name>
        └── workspace