ggml_ot.pl.clustermap_embedding

ggml_ot.pl.clustermap_embedding#

ggml_ot.pl.clustermap_embedding(distances, labels, *, plot='clustermap_embedding', title=None, linkage='complete', show=None, save=None, **kwargs)[source]#

Plot a clustermap, an embedding, or both side-by-side.

Wraps ggml_ot.pl.clustermap() and ggml_ot.pl.embedding().

Parameters:
distances numpy.ndarray

Precomputed pairwise distance matrix.

labels list

Class label for each sample.

plot str, default "clustermap_embedding"

Which plot(s) to draw. One of "clustermap", "embedding", "clustermap_embedding".

title str or None, default None

Overall figure title.

show bool or None, default None

Whether to display the plot. None (default) automatically shows in interactive environments (notebooks, IPython) and suppresses in scripts. True/False override explicitly.

save str, bool, or None, default None

Whether to save the figure to disk. None/False skip saving. True saves to settings.figdir/clustermap_embedding.<figformat>; a str overrides the filename.

**kwargs

Forwarded to clustermap() and emb().

Returns:

matplotlib.figure.Figure The composed figure.