Sample.heatmap

Sample.heatmap(clusterby, sortby, drop=None, flatten=True)

Multi-assay heatmap.

Plots heatmaps (cluster vs target) for each available assay next to each other. The plots can either be “flattened”, in which case the heatmap shows the median target value for all barcodes in the cluster. Or “not flattened”, in which case all barcodes are shown within each cluster.

Parameters

clusterbystr

The assay name (‘dna’, ‘protein’) whose labels will be used to cluster the barcodes.

sortbystr

The assay name (‘dna’, ‘protein’) whose labels will be used to sort the barcodes within each cluster.

dropstr

At most one of (‘dna’, ‘protein’, ‘cnv’) that is to be dropped.

flattenboolean

Determines whether to display the median of barcodes for each cluster at each target (True) or plot each barcode, grouped by cluster, at each target (False).

Returns

figplotly.graph_objects.Figure