Skip to content

msmu.pl.plot_umap

Plots UMAP embeddings for a modality colored/grouped by observations.

Parameters:

Name Type Description Default
mdata MuData

MuData object containing UMAP embeddings.

required
modality str

Target modality; defaults to 'protein'.

'protein'
groupby str | None

Observation column used to group traces.

None
colorby str | None

Observation column used for coloring (when applicable).

None
template str

Plotly template for colorway.

DEFAULT_TEMPLATE
obs_column str | None

Observation column used for labeling/group resolution.

None
key str

Key in .obsm where the UMAP dimensions are stored; defaults to 'X_umap'.

'X_umap'
**kwargs str

Additional layout options forwarded to Plotly.

{}

Returns:

Type Description
Figure

Scatter plot of UMAP embeddings.