omics_utils.AnnDataConverter#

class omics_utils.AnnDataConverter(obs_cols, genes)#

Bases: object

Converter between AnnData objects and DataFrames with serialized sparse matrices.

NOTE: This class only keeps X, obs and var_names, everything else will be discarded.

__init__(obs_cols, genes)#
Parameters:
  • obs_cols (list[str]) – Columns to retain from the obs DataFrame, e.g. sample-level metadata

  • genes (list[str]) – Genes to retain from the X array. Inserts columns which are in this list but not in the data as empty columns.

Methods

__init__(obs_cols, genes)

anndata_to_dataframe(adata)

Convert an AnnData object to a DataFrame.

dataframe_to_anndata(df[, var])

Convert a DataFrame back to an AnnData object.

join_metadata(df, obs)

Join the observation metadata and IDs to the main DataFrame.

reindex_anndata_genes(adata, genes)

Reindex AnnData to exactly match a gene list while preserving sparsity.

serialize(adata)

Serialize a Dask-backed AnnData object.

anndata_to_dataframe(adata)#

Convert an AnnData object to a DataFrame.

The result will have all obs metadata plus a sparse_vector column containing the serialized expression data for each cell.

Parameters:

adata (AnnData) – AnnData object to convert

Return type:

list[Delayed]

Returns: List of Delayed serialization tasks.

dataframe_to_anndata(df, var=None)#

Convert a DataFrame back to an AnnData object.

Parameters:
  • df (DataFrame) – DataFrame with serialized expression data

  • var (DataFrame | None) – DataFrame with gene metadata to include in the AnnData object

Return type:

AnnData

Returns:

Reconstructed AnnData object.

join_metadata(df, obs)#

Join the observation metadata and IDs to the main DataFrame.

Parameters:
  • df (DataFrame) – DataFrame containing the cells as serialized strings.

  • obs (DataFrame) – DataFrame containing AnnData.obs.

Return type:

DataFrame

Returns:

The joined DataFrame.

reindex_anndata_genes(adata, genes)#

Reindex AnnData to exactly match a gene list while preserving sparsity.

Parameters:
  • adata (AnnData) – AnnData object to reindex

  • genes (list[str]) – List of gene names to enforce

Return type:

AnnData

Returns:

New AnnData object with exactly the genes specified, in the specified order.

serialize(adata)#

Serialize a Dask-backed AnnData object.

Parameters:

adata (AnnData) – The AnnData object to serialize.

Return type:

list[Delayed]

Returns:

A list of Delayed tasks computing the serialized entries from the AnnData object.