decoupler.check_corr

decoupler.check_corr(net, source='source', target='target', weight='weight', mat=None, min_n=5, use_raw=True)

Checks the correlation across the regulators in a network. If a mat is also provided, target features will be prunned to match the ones in mat.

Parameters
netDataFrame

Network in long format.

sourcestr

Column name with source nodes.

targetstr

Column name with target nodes.

weightstr

Column name with weights.

matlist, DataFrame or AnnData

Optional. If given, target features be filtered if they are not in mat.

min_nint

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

use_rawbool

Use raw attribute of mat if present.

Returns
corrDataFrame

Correlation pairs dataframe.