decoupler.run_mlm

decoupler.run_mlm(mat, net, source='source', target='target', weight='weight', batch_size=10000, min_n=5, verbose=False, use_raw=True)

Multivariate Linear Model (MLM).

Wrapper to run MLM.

Parameters:
matlist, pd.DataFrame or AnnData

List of [features, matrix], dataframe (samples x features) or an AnnData instance.

netpd.DataFrame

Network in long format.

sourcestr

Column name in net with source nodes.

targetstr

Column name in net with target nodes.

weightstr

Column name in net with weights.

batch_sizeint

Size of the samples to use for each batch. Increasing this will consume more memmory but it will run faster.

min_nint

Minimum of targets per source. If less, sources are removed.

verbosebool

Whether to show progress.

use_rawbool

Use raw attribute of mat if present.

Returns:
Returns mlm activity estimates and p-values or stores them in mat.obsm[‘mlm_estimate’] and mat.obsm[‘mlm_pvals’].