mmcci.it.lr_integration
- mmcci.it.lr_integration(samples, method='>=50%', sum=False, strict=False, assay='raw', integrate_pvals=True, p_val_method='stouffer', metadata=None, weights=None) CCIData[source]
Integrates a list of samples into a single sample per lr pair.
- Parameters:
samples (list) – A list of CCIData objects.
method (str) (optional) – The method to use for identifying LR pairs. Options are “intersection”, “>=50%”, “>50%”, and “union”. Defaults to “>=50%”.
sum (bool) (optional) – Whether to sum instead of multiply the matrices. Defaults to False.
strict (bool) (optional) – If True, only interactions where more than 50% of the values are non-zero will be multiplied. Defaults to False.
assay (str) (optional) – The assay or assays to use for integrating samples. Defaults to “raw”.
integrate_pvals (bool) (optional) – Whether to integrate p-values (if possible). Defaults to True.
p_val_method (str) (optional) – The method to use for combining p-values. Options are “stouffer” and “fisher”. Defaults to “stouffer”.
metadata (dict) (optional) – Additional metadata to include in the integrated sample. Defaults to None.
weights (list) (optional) – A list of weights to apply to each sample during integration. Defaults to None.
- Returns:
The integrated sample.
- Return type: