_Assay.run_umap#
missionbio.mosaic.assay._Assay.run_umap
- _Assay.run_umap(attribute: Union[str, ndarray, DataFrame], output_label: str = 'umap', **kwargs: Any) None #
Perform UMAP on the given data.
Adds output_label to the row attributes.
metric=”nan-l2” is also accepted. In that case, the distance metric passed to UMAP calculates the L2-norm between cells ignoring NaN values.
- Parameters:
- attributestr
The attribute to be used for UMAP. Uses
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.
< Class _Assay