_Assay.run_umap

_Assay.run_umap(attribute, output_label='umap', **kwargs)

Perform UMAP on the given data.

Adds output_label to the row attributes.

Parameters

attributestr

The attribute to be used for UMAP. Uses :met:`_Assay.get_attribute` to retrieve the values constrained by row.

output_labelstr, default UMAP_LABEL

The name of the row attribute where the UMAP output is.

kwargsdictionary

Passed to UMAP.

Raises

ValueError

When both layer and attribute are provided. Only one is permitted at a time.