Protein.heatmap

Protein.heatmap(attribute, splitby='label', features=None, bars_order=None, convolve=0, title='')

Heatmap of all barcodes and ids.

Parameters

attributestr / np.ndarray

An attribute with the shape equal to the shape of the assay. Uses _Assay.get_attribute() to retrieve the values constrained by row+col.

splitbystr / np.ndarray, default LABEL

Whether to order the barcodes based on the given labels or not. Only applicable when bars_order is None. Uses _Assay.get_attribute() to retrieve the values constrained by row. The shape must be equal to (#cells).

featureslist

The ids that are to be shown. This also sets the order in which the ids are shown.

bars_orderlist

The barcodes that are to be plotted. The order in the plot is the same as the order in the list. Passing this sets splitby to None.

convolvefloat [0, 100]:

The percentage of barcodes from the label with the fewest barcodes that is used to average out the signal. If 0, then no convolution is performed, and if 100, the mean per label is returned. Only applicable when splitby is not None.

titlestr

The title to be added to the plot.

Returns

figplotly.graph_objects.FigureWidget

Raises

ValueError

Raised in the following cases. When convolve is below 0 or above 100. When the number of ids is too large to hierarchically cluster the cells and features is not provided.