c2v.utils.regress_categories

c2v.utils.regress_categories#

c2v.utils.regress_categories(adata, obs_key, layer=None, key_added='regressed')#

Performs expression regression on categorical variables in obs_key. Instead of calculation of full regression model, it calculates mean centering. Can be effectively used to exclude effect of the cell type signature from the expression matrix.

Parameters:
adata sc.AnnData

AnnData object with expression data.

obs_key str | list[str]

Categorical variables in obs to regress.

layer str | None, optional

Layer in adata.layers to regress. If None, use adata.X. Default is None.

key_added str, optional

Key in adata.layers to add regressed expression. Default is “regressed”.

Return type:

None