search

AlexsLemonade / scpca-docs

User information about ScPCA processing
https://scpca.readthedocs.io/en/latest/
BSD 3-Clause "New" or "Revised" License
0 stars 1 forks source link

Add merged to downloadable files #234

Closed sjspielman closed 9 months ago

sjspielman commented 9 months ago

Closes #217 ~Closes #218~

This PR adds the merged object downloads to the download_files.md docs. I'm opening this as a Draft because I think a little more discussion is warranted before a formal review.

In #217, we decided to add the merged objects downloads after sce/anndata. But when I went to implement this, the situation seemed more involved (or maybe I misinterpreted what was meant by "after sce/anndata"!).

As a first stab/jumping off point, I ended up splitting the document into two main sections: Individual sample object downloads and Merged sample object downloads. The vast majority of the existing content is now in the Individual (with all headers knocked down 1 level to be nested in this section).

After we discuss, I'll make any organizational changes and formally request review!

sjspielman commented 9 months ago

This PR is now ready for text review. We are still waiting on updated images that include all the metadata TSVs. I've left placeholders for these images which we can either add in this PR or in a subsequent PR after this one.

Please let me know also any thoughts on how the merged section itself is organized!

sjspielman commented 9 months ago

Ready for another look! I added the recommended content, and I also left one TODO where we might want to link in the FAQ which is currently filed in #244. If you think linking is a good idea, then we can leave this open until #244 is set, add the link correctly, and then wrap this PR up.

sjspielman commented 9 months ago

Ok, with your suggestion (https://github.com/AlexsLemonade/scpca-docs/pull/234/commits/f07d495489cd6c1a68a6b712f5c089ee8612a6ba), there is now still a header Merged object metadata with one sentence, just about single_cell_metadata.tsv