gedi2py.tools.dispersion

gedi2py.tools.dispersion(adata, *, key='gedi', copy=False)[source]

Compute gene dispersion from GEDI model.

Dispersion is computed as variance / mean (coefficient of variation squared) from the imputed expression values.

Parameters:

  • adata (AnnData) – Annotated data matrix with GEDI results.

  • key (str, default: 'gedi') – Key in adata.uns where GEDI results are stored.

  • copy (bool, default: False) – If True, return dispersion vector instead of storing in adata.

Return type:

AnnData | ndarray | None

Returns:

  • If ``copy=True``, returns dispersion vector (n_genes,).

  • Otherwise, stores in ``adata.var[``’{key}_dispersion’:py:class:`]` and returns ``None`.`

Examples

>>> import gedi2py as gd
>>> gd.tl.gedi(adata, batch_key="sample", n_latent=10)
>>> gd.tl.dispersion(adata)
>>> adata.var["gedi_dispersion"]