Skip to content

docs: document the adata.uns['hvg'] output of pp.highly_variable_genes #4344

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.

Sign up for GitHub

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

Open
asharaali wants to merge 1 commit into
base: main
Choose a base branch
from
+4 −0
Open

docs: document the adata.uns['hvg'] output of pp.highly_variable_genes #4344

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions src/scanpy/preprocessing/_highly_variable_genes.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -757,6 +757,10 @@ def highly_variable_genes( # noqa: PLR0913
If `batch_key` is given, this denotes in how many batches genes are detected as HVG
`adata.var['highly_variable_intersection']` : :class:`pandas.Series` (dtype `bool`)
If `batch_key` is given, this denotes the genes that are highly variable in all batches
`adata.uns['hvg']` : :class:`dict`
Dictionary with a `'flavor'` entry recording the `flavor` used.
:func:`scanpy.pl.highly_variable_genes` reads it to decide whether to plot
dispersions or variances

"""
if isinstance(flavor, Default):
Expand Down
Loading