ehrapy.preprocessing.scale_norm#

ehrapy.preprocessing.scale_norm(adata, vars=None, copy=False, **kwargs)[source]#

Apply scaling normalization.

Functionality is provided by scale(), see https://scikit-learn.org/stable/modules/generated/sklearn.preprocessing.scale.html for details.

Parameters:

  • adata (AnnData) – AnnData object containing X to normalize values in. Must already be encoded using encode().

  • vars (Union[str, Sequence[str], None]) – List of the names of the numeric variables to normalize. If None all numeric variables will be normalized. Defaults to None .

  • copy (bool) – Whether to return a copy or act in place . Defaults to False .

  • **kwargs – Additional arguments passed to scale()

Return type:

Optional[AnnData]

Returns:

AnnData object with normalized X. Also stores a record of applied normalizations as a dictionary in adata.uns[“normalization”].

Examples

>>> import ehrapy as ep
>>> adata = ep.dt.mimic_2(encoded=True)
>>> adata_norm = ep.pp.scale_norm(adata, copy=True)