Skip to content

docs(plotting): add inline plot examples to highest_expr_genes and highly_variable_genes #4025

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
haoyu-haoyu wants to merge 1 commit into
base: main
Choose a base branch
from
+33 −0
Open

docs(plotting): add inline plot examples to highest_expr_genes and highly_variable_genes #4025

Show file tree
Hide file tree
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
17 changes: 17 additions & 0 deletions src/scanpy/plotting/_preprocessing.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -41,6 +41,23 @@ def highly_variable_genes( # noqa: PLR0912
A string is appended to the default filename.
Infer the filetype if ending on {{`'.pdf'`, `'.png'`, `'.svg'`}}.

Examples
--------
.. plot::
:context: close-figs

import scanpy as sc
adata = sc.datasets.pbmc3k_processed()
sc.pp.highly_variable_genes(adata)
sc.pl.highly_variable_genes(adata)

Plot on log axes

.. plot::
:context: close-figs

sc.pl.highly_variable_genes(adata, log=True)

"""
if isinstance(adata_or_result, AnnData):
result = adata_or_result.var
Expand Down
16 changes: 16 additions & 0 deletions src/scanpy/plotting/_qc.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,22 @@ def highest_expr_genes(
-------
If `show==False` a :class:`~matplotlib.axes.Axes`.
Examples
--------
.. plot::
:context: close-figs
import scanpy as sc
adata = sc.datasets.pbmc3k_processed()
sc.pl.highest_expr_genes(adata)
Show only the top 10 genes
.. plot::
:context: close-figs
sc.pl.highest_expr_genes(adata, n_top=10)
"""
import seaborn as sns # Slow import, only import if called

Expand Down
Loading