metachat.tl.communication_group
- metachat.tl.communication_group(adata, database_name=None, group_name=None, summary='sender', sum_metabolites=None, sum_metapathways=None, sum_customerlists=None, sum_ms_pairs=None, n_permutations=100, use_parallel=True, n_jobs=16, copy=False)[source]
Summarize metabolic communication to group-level MCC and compute p-values via label permutation.
Parameters
- adataanndata.AnnData
The data matrix of shape
n_obs×n_var. If compute MCC flow from specific metabolites, metapathways or customerlists, please runmc.tl.summary_communication()first.- database_namestr
Name of the Metabolite-Sensor interaction database.
- group_namestr
Column key in
adata.obsspecifying cell or spot group labels.- summary{‘sender’, ‘receiver’}, default=’sender’
Whether to summarize sender- or receiver-side communication.
- sum_metaboliteslist of str, optional
List of specific metabolites to summarize, e.g.
['HMDB0000148', 'HMDB0000674'].- sum_metapathwayslist of str, optional
List of metabolic pathways to summarize, e.g.
['Alanine, aspartate and glutamate metabolism', 'Glycerolipid Metabolism'].- sum_customerlistsdict, optional
Custom metabolite–sensor pair groups to summarize. Example: ``{‘CustomerA’: [(‘HMDB0000148’, ‘Grm5’), (‘HMDB0000148’, ‘Grm8’)],
‘CustomerB’: [(‘HMDB0000674’, ‘Trpc4’), (‘HMDB0000674’, ‘Trpc5’)]}``.
- sum_ms_pairslist of str, optional
Specific metabolite–sensor pairs, e.g.
['HMDB0000148-Grm5'].- n_permutationsint, default=100
Number of random label permutations for p-value estimation.
- use_parallelbool, default=True
Whether to use multiprocessing.
- n_jobsint, default=16
Number of parallel worker processes.
- copybool, default=False
If True, return a copy of the AnnData object; otherwise modify in place.
Returns
- anndata.AnnData or None
Adds group-level communication results into:
.uns['MetaChat_group-{group_name}-{database_name}-{item_name}']Each key contains a dict with: -['communication_matrix']: group × group MCC intensity -['communication_pvalue']: permutation-based p-values Ifcopy=True, returns the modified AnnData object.