voyagerpy.utils.model_gene_var#

voyagerpy.utils.model_gene_var(adata: AnnData, block=None, design=None, subset_row=None, subset_fit=None, gene_names=None, layer: str | None = None, ddof: int = 1) → DataFrame#

Return the modelled gene variance.

Modelled on similar method in SCRAN package.

Parameters:

  • adata (AnnData) – The annotated data matrix.

  • block (None, optional) – Compatibility with R. The default is None.

  • design (None, optional) – Compatibility with R. The default is None.

  • subset_row (ndarray, optional) – If only a subset of the rows are used. The default is None.

  • subset_fit (bool, optional) – if subsetting should occur, yet to be implmented. The default is None.

  • gene_names (ndarray, optional) – If gene names are provided. The default is None.

Returns:

collected – Information on modelled variance into biological and technical.

Return type:

DataFrame

Note

The following parameters are not implemented:

  • block

  • design

  • subset_row

  • subset_fit