Currently our dataset is published with a README.pdf, but Quilt does not render this. I've migrated the README.pdf to a README.md markdown file that Quilt can render.
This documentation is about the dataset, not directly about this code, so technically it doesn't need to be in this repository. I'm putting it here for the following reasons:
By hosting dataset_structure.svg here, we don't have to have it in the S3 bucket where it could create confusion as an extraneous file
Allows us to review changes to docs via pull requests
Github will render markdown to preview it before pushing to S3
Implementation
Since images cannot be embedded directly in markdown files, the image dataset_structure.svg is its own file.
To avoid putting the dataset_structure.svg file on quilt, the link to it is an absolute link to github.com. As a write this, the link uses the branch name quilt-readme because that's where the file exists, but I'll update it to bioRxiv-v1 before merging this pull request.
Purpose
Currently our dataset is published with a README.pdf, but Quilt does not render this. I've migrated the README.pdf to a README.md markdown file that Quilt can render.
This documentation is about the dataset, not directly about this code, so technically it doesn't need to be in this repository. I'm putting it here for the following reasons:
dataset_structure.svghere, we don't have to have it in the S3 bucket where it could create confusion as an extraneous fileImplementation
Since images cannot be embedded directly in markdown files, the image
dataset_structure.svgis its own file.To avoid putting the
dataset_structure.svgfile on quilt, the link to it is an absolute link to github.com. As a write this, the link uses the branch namequilt-readmebecause that's where the file exists, but I'll update it tobioRxiv-v1before merging this pull request.