msmu.pl.plot_correlation

Plot a lower-triangular Pearson correlation heatmap of grouped medians.

Parameters:

Name	Type	Description	Default
mdata	MuData	MuData containing the selected modality and observation metadata.	required
modality	str	Name of the modality to plot, such as "protein" or "psm".	'protein'
groupby	str | None	Grouping column in observation metadata (or feature metadata where supported). None uses the resolved obs_column.	None
obs_column	str | None	Sample identifier in mdata.obs. If omitted, uses .uns["plotting"]["default_obs_column"], then source name/source_name/sample/filename, then the observation index.	None
kwargs	str	Additional plotly layout options, for example width=800 or title_text="QC".	{}

Returns:

Type	Description
Figure	plotly Figure. Call .show() to display or .write_html("plot.html") to export.

Notes

Computes correlations for the plot from .X; it does not consume results from corr. Quantification and embeddings are unchanged. Resolving an existing sample-identifier column can convert that column in mdata.obs to categorical; pass a copy to preserve its dtype.

Examples:

import msmu as mm
fig = mm.pl.plot_correlation(mdata, modality="protein")
fig.show()