cytomining / cytomining/profiling-handbook

Handbook discrepancy: metadata/<batch> vs metadata/<batch>/platemaps

Open
#70 8 comments 0 reactions 0 assignees View on GitHub
Dominant language
No language data
Stars
11
Forks
7
PR merge metrics
No merged PRs in 30d

Description

Having the metadata broken out into platemaps and external is still a relatively new thing, and the image analysis team to date has typically only ever dealt with the platemap level metadata. Thus, on AWS, metadata is stored as `s3://${BUCKET}/projects/${PROJECT_NAME}/workspace/metadata/${BATCH_ID}`, as evidenced in this [sync command](https://github.com/cytomining/profiling-handbook/blob/master/05-create-profiles.md?plain=1#L322).

BUT, for the recipe, we eventually want it in `s3://${BUCKET}/projects/${PROJECT_NAME}/workspace/metadata/platemaps/${BATCH_ID}`, as depicted in [this tree structure](https://github.com/cytomining/profiling-handbook/blob/master/05-create-profiles.md?plain=1#L172-L179). We currently handle that with just adding that extra `platemaps` in during the sync command above.

BUT, that's not what the handbook implies - it implies that it should be uploaded in the tree structure. So we basically have one of a couple of choices - 1) Explain everything I just wrote here in the handbook and show both tree structures there or 2) From now on, change how the analysts structure things and update the sync command, because presumably in places like the gallery in the future (but I don't know that anyone has checked for current bits of metadata over there), we want this new structure.

I'm guessing the preference here is 2, but we should make a decision and update the handbook accordingly.

Contributor guide

No contributing guide indexed for this repository

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.