decoupler.swap_layer

decoupler.swap_layer(adata, layer_key, inplace=False)

Swaps an adata.X for a given layer.

Swaps an AnnData X matrix with a given layer. Generates a new object by default.

Parameters:

adataAnnData

Annotated data matrix.

layer_keystr

.layers key to swap.

inplacebool

If False, return a copy. Otherwise, do operation inplace and return None.

Returns:

layerAnnData, None

If inplace=False, new AnnData object with the given layer in X and the original X stored in .layers.