docs: document the adata.uns['hvg'] output of pp.highly_variable_genes - #4344
Open
asharaali wants to merge 1 commit into
Open
docs: document the adata.uns['hvg'] output of pp.highly_variable_genes#4344asharaali wants to merge 1 commit into
adata.uns['hvg'] output of pp.highly_variable_genes#4344asharaali wants to merge 1 commit into
Conversation
…enes`
`highly_variable_genes` writes `adata.uns['hvg'] = {'flavor': flavor}` when
`inplace=True`, on both the dispersion-based and the seurat_v3 paths, but the
`Returns` section lists only the `adata.var` columns.
The entry is part of the contract with downstream code rather than incidental
bookkeeping: `pl.highly_variable_genes` reads `adata.uns['hvg']['flavor']` to
choose whether to plot dispersions or variances, in both the legacy and the
holoviews backends, and raises `KeyError: 'hvg'` without it.
Closes scverse#4341
Signed-off-by: Ashar Ali <aaa467@njit.edu>
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #4344 +/- ##
=======================================
Coverage 81.98% 81.98%
=======================================
Files 134 134
Lines 13235 13235
=======================================
Hits 10851 10851
Misses 2384 2384
Flags with carried forward coverage won't be shown. Click here to find out more.
|
Member
|
Please cut down the PR description with the AI slop |
Author
|
Trimmed. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
.unsoutput forscanpy.pp.highly_variable_genesis not documented #4341pp.highly_variable_geneswritesadata.uns['hvg'] = {'flavor': flavor}wheninplace=True, but theReturnssection documents only theadata.varcolumns.pl.highly_variable_genesreads that entry to pick which metrics to plot, so deleting it raisesKeyError: 'hvg'.Adds one entry to
Returns. No behaviour change.