c2v.utils.stack_layers

c2v.utils.stack_layers(adata, layers=None, layer_col_added='layer', mask_key=None)

Function stacks layers of an AnnData object into a single layer in adata.X.

Parameters:

adata sc.AnnData

AnnData object with layers to stack.

layers list[str] | None, optional

Layers to stack. If None, all layers are stacked. Default is None.

layer_col_added str, optional

Name of the column added to obs to indicate the layer. Default is “layer”.

mask_key str | None | Literal[False], optional

Key in obsm to boolean mask of cells to include in the stack. If None, tries to use “mask_key” in adata.uns. Default is None.

Return type:

None