opendvp.plotting.correlation_heatmap

opendvp.plotting.correlation_heatmap(adata, correlation_method='spearman', title='Spearman Correlation Heatmap', sample_label='raw_file_id', return_fig=False, ax=None, **kwargs)

Plot a correlation heatmap of the protein abundance for all samples in adata.

Return type:

Figure | None

Parameters

adataAnnData

Annotated data matrix.

correlation_methodstr, optional

Method to calculate the correlation (default = “spearman”).

titlestr, optional

Title of the plot.

sample_labelstr, optional

Column name in adata.obs to label samples with.

return_figbool, optional

If True, returns the matplotlib Figure object for further customization. If False, shows the plot.

axmatplotlib.axes.Axes, optional

Axes object to plot on. If None, a new figure and axes are created.

**kwargs

Additional keyword arguments passed to seaborn.heatmap.

Returns:

figmatplotlib.figure.Figure or None

The figure object if return_fig is True, otherwise None.