liana.utils.get_factor_scores

liana.utils.get_factor_scores#

liana.utils.get_factor_scores(adata, obsm_key=None, obs_keys=None)#

Extract factor scores from an AnnData object.

Parameters:
  • adata (AnnData | MuData) – Annotated data object.

  • obsm_key (str (default: None)) – Key to use when extracting factor scores from adata.obsm

  • obs_keys (str | None (default: None)) – List of keys to use when extracting metadata from adata.obs If None, no metadata is extracted. Default is None.

Return type:

DataFrame

Returns:

Returns a pandas DataFrame with the factor scores.

Raises:

ValueError – If obsm_key not in .obsm