Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Tkakar/cat 1015 document containers #142

Merged
merged 9 commits into from
Jan 22, 2025

Conversation

tkakar
Copy link
Collaborator

@tkakar tkakar commented Jan 3, 2025

This PR expands the readme in each container to explicitly state the inputs, outputs, as well as any normalization done to the inputs.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This test folder had slipped into the last PR, so removed it here.

@tkakar tkakar requested a review from NickAkhmetov January 3, 2025 17:01
Copy link
Contributor

@NickAkhmetov NickAkhmetov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good! I think we should link to the example datasets directly; I also spotted a few minor typos.

containers/anndata-to-ui/README.md Outdated Show resolved Hide resolved
containers/seg-mudata-to-zarr/README.md Outdated Show resolved Hide resolved
containers/seg-mudata-to-zarr/README.md Outdated Show resolved Hide resolved
containers/scatac-csv-to-arrow/README.md Outdated Show resolved Hide resolved

## Normalization
All data from the input is scaled to [zero-mean unit-variance] (https://github.com/hubmapconsortium/salmon-rnaseq/blob/master/bin/analysis/scanpy_entry_point.py#L31-L33).
Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@NickAkhmetov I copied it from the anndata-to-ui readme assuming they both follow the same normalization, can you please confirm if this is correct?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

There's some similar code in the multiome pipeline to avoid confusion: https://github.com/hubmapconsortium/multiome-rna-atac-pipeline/blob/a52b6bb37f56dcd78d45ceef1868095d59ef1aac/bin/downstream.py#L30-L37

My understanding is that anything that uses the mudata-to-ui pipeline is passed through the multiome-rna-atac-pipeline beforehand, so it seems logical to link to that pipeline instead.

@tkakar tkakar requested a review from NickAkhmetov January 15, 2025 18:46
Copy link
Contributor

@NickAkhmetov NickAkhmetov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🚀

@tkakar tkakar merged commit 71e6bf1 into master Jan 22, 2025
2 checks passed
@tkakar tkakar deleted the tkakar/cat-1015-document-containers branch January 22, 2025 16:30
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants