Add documentation for hdf5plugin compression usage when writing to h5ad #857
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Codecov Report
Additional details and impacted files@@ Coverage Diff @@
## master #857 +/- ##
=======================================
Coverage 83.59% 83.59%
=======================================
Files 32 32
Lines 4365 4365
=======================================
Hits 3649 3649
Misses 716 716
|
ivirshup
reviewed
Dec 1, 2022
|
Actually, I want to do some fiddling with the docs that would make conflicts, so I've gone ahead and added a release note. Let me know if you'd want me to rephrase Thanks for the PR! |
|
No problem, thanks for maintaining this project! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Following up on the discussion around #828, the changes in this new PR add documentation related to hdf5plugin library usage for
anndata.write_h5ad. Users are pointed to the relevant documentation from that project, usage examples are provided, and caveats related to reading hdf5plugin-compressed datasets are noted!