Documentation - File Manifest structure and requirements #472
Description
Summary of request
Score relies on the use of manifest files for both the upload and download of multiple files, but the precise formatting of these files is not well documented outside of the code itself. A human readable file describing manifest contents needs to be added to the repo. This will act as both the rules that should govern the code functionality, but also as a reference for developers/users interacting with Score for file upload/download.
Details
Documentation needs to include the list of columns in a manifest file that are required and the order they are required in, plus the expected values in each column. Any other file content (headers? filenames? file extensions? csv vs tsv?) need to also be declared.
Desired solution
A markdown file should be created to capture all the rules around Score Manifest files. This can be added in a /docs directory in this repo or directly to the wiki. If modifying the existing /docs content, we should first review if that documentaiton format should be maintained and where.
Additional context
Requested here: #424
Manifest generation steps are detailed on overture.bio site documentation in several spots:
- https://www.overture.bio/documentation/guides/submission/clientsubmission/#step-4-generate-a-manifest
- https://www.overture.bio/documentation/song/user/submit/#step-3-generate-a-manifest-file
- https://www.overture.bio/documentation/score/user-guide/upload/#upload-example
- https://www.overture.bio/documentation/score/user-guide/download/