Skip to content

docs: add inline example plot to sc.pl.pca_variance_ratio #4056

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

Merged
flying-sheep merged 1 commit into from
Apr 17, 2026
+18 −0
Merged

docs: add inline example plot to sc.pl.pca_variance_ratio #4056

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
18 changes: 18 additions & 0 deletions src/scanpy/plotting/_tools/__init__.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -202,6 +202,24 @@ def pca_variance_ratio(
A string is appended to the default filename.
Infer the filetype if ending on {`'.pdf'`, `'.png'`, `'.svg'`}.

Examples
--------
Plot the variance ratio for the first 30 PCs.

.. plot::
:context: close-figs

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

Plot on a logarithmic scale.

.. plot::
:context: close-figs

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

"""
ranking(
adata,
Expand Down
Loading