Sample.heatmap

Contents

Sample.heatmap#

missionbio.mosaic.sample.Sample.heatmap

Sample.heatmap(clusterby: Optional[Sequence[str]] = None, attributes: Optional[Sequence[str]] = None, features: Optional[Sequence[Union[Sequence, str]]] = None, x_groups: Optional[Sequence[Union[Sequence, str]]] = None, bars_order: Optional[Sequence] = None, widths: Optional[Sequence[float]] = None, order: Tuple[str] = ('dna', 'protein', 'cnv', 'rna'))#

Multi-assay heatmap.

Plots heatmaps (cluster vs target) for each available assay next to each other.

Parameters:
clusterbylist, str

The assays to plot. If None, all assays are plotted.

attributestuple

The layers or row attributes to plot for each assay

featurestuple

The features to plot for each assay. If None, all features are plotted. For CNV, the additional options are described in missionbio.mosaic.cnv.Cnv.heatmap(). It includes {“positions”, “genes”} or a subset of positions or genes.

x_groupstuple

The groups to plot on the x-axis for each assay. If None, the x-axis is not grouped.

bars_orderSequence

The order of the barcodes to plot. If None, the barcodes are sorted by the sortby assay. If sortby is None, the barcodes are sorted by the first assay.

widthslist

The width of each heatmap. If None, the width is automatically determined.

ordertuple

The order of the assays to plot.

Returns:
figplotly.graph_objects.Figure

< Class Sample