dotools_py.get.layer_swap

dotools_py.get.layer_swap(adata, layer_key, x_key='X', inplace=True)

Swap adata.X with adata.layers.

Parameters:

adata AnnData

Annotated data matrix.

layer_key str

Valid key in adata.layers

x_key str | None (default: 'X')

Key to use to save adata.X in adata.layers. Set to None to not copy adata.X in adata.layers

inplace bool (default: True)

Whether to generate a new object or make changes inplace.

Return type:

AnnData | None

Returns:

Returns None or an AnnData object if inplace is set to False.