cellrank.pl.terminal_states¶
-
cellrank.pl.
terminal_states
(adata, discrete=False, states=None, cluster_key=None, mode='embedding', time_key='latent_time', **kwargs)[source]¶ Plot terminal states uncovered by
cellrank.tl.terminal_states
.- Parameters
adata¶ (
anndata.AnnData
) – Annotated data object.discrete¶ (
bool
) – If True, plot probability distribution of terminal states. Only available when terminal were estimated bycellrank.tl.estimators.GPCCA
.states¶ (
Union
[str
,Sequence
[str
],None
]) – Subset of terminal states to plot. If None, plot all terminal states.cluster_key¶ (
Optional
[str
]) – If given, plot cluster annotations left of the terminal states.Can be either ‘embedding’ or ‘time’:
’embedding’ - plot the embedding while coloring in the absorption probabilities.
’time’ - plot the pseudotime on x-axis and the absorption probabilities on y-axis.
time_key¶ (
str
) – Key inadata.obs
where the pseudotime is stored.basis¶ – Basis to use when
mode='embedding'
. If None, use ‘umap’.**kwargs¶ – Keyword arguments for
cellrank.tl.estimators.BaseEstimator.plot_terminal_states()
.
- Returns
Nothing, just plots the figure. Optionally saves it based on
save
.- Return type