Skip to content

msmu.pl.plot_pca

Plots PCA scores for a modality colored/grouped by observation metadata.

Parameters:

Name Type Description Default
mdata MuData

MuData object containing PCA results.

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
pcs tuple[int, int] | list[int]

Pair of principal component indices (1-based).

(1, 2)
obs_column str | None

Observation column used for labeling/group resolution.

None
key str

Base key for PCA outputs; expects coordinates in .obsm[key] and variance metadata in .uns[key]. Defaults to 'X_pca'.

'X_pca'
**kwargs str

Additional layout options forwarded to Plotly.

{}

Returns:

Type Description
Figure

Scatter plot of PCA scores.