grassp.pl.sample_heatmap#
- sample_heatmap(data, distance_metric='correlation', show=True)[source]#
Correlation heat-map between samples (columns of
data
).- Parameters:
- data
AnnData
AnnData object where the variables represent individual samples (e.g. pull-downs or fractions). Correlations are computed across the observation axis.
- distance_metric
Literal
['euclidean'
,'cosine'
,'correlation'
,'cityblock'
,'jaccard'
,'hamming'
] (default:'correlation'
) Distance metric for
scipy.spatial.distance.pdist()
. Not used directly at the moment (the function plots correlations), but kept for API symmetry withprotein_clustermap()
.- show
bool
(default:True
) If
True
show the figure and returnNone
. Otherwise return theseaborn.matrix.ClusterGrid
instance.
- data
- Return type:
ClusterGrid
|None
- Returns:
ClusterGrid object if
show
isFalse
.