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 matrix section of merged objects docs page #229

Closed sjspielman closed 9 months ago

sjspielman commented 9 months ago

Towards #219

This PR establishes a merged_objects.md documentation page, to be listed right after sce_file_contents.md. To begin, I have written opening sections for both SCE and AnnData objects about accessing matrices. Along the way, I also made some associated change in the "mirrored" sections of sce_file_contents.md.

I figure this page is best handled via a couple stacked PRs to avoid docs review fatigue! So, expect a couple more after this.

During review, let me know if I went too far and/or not far enough with some of these changes, and of course any wording reviews for the merged object version! These are the particular additions I made:

sjspielman commented 9 months ago

Thanks for the useful feedback @allyhawkins! I definitely needed a lot more (or like, any...) emphasis that merged objects are in fact merged. I have rephrased the areas as requested, and I included a little extra language in the overall intro - lmk what you think should be kept and what should be discarded!

sjspielman commented 9 months ago

I'm not actually sure what the right code is to pull out this matrix in the AnnData object. It appears to be there, if I'm interpreting layers: 'logcounts', 'spliced' correctly? Any guidance here on how to do things in python would be great!

Also excited to not have to figure this out 😉