omnipath.requests.Complexes.complex_genes

classmethod Complexes.complex_genes(genes, complexes=None, total_match=False)[source]

Get all the molecular complexes for a given genes.

This function returns all the molecular complexes where an input set of genes participate. User can choose to retrieve every complex where any of the input genes participate or just retrieve these complexes where all the genes in input set participate together.

Parameters:

  • genes (Union[str, Iterable[str]]) – The genes for which complexes will be retrieved (hgnc format).

  • complexes (Optional[DataFrame]) – Complex data from get(). If None, new request will be made.

  • total_match (bool) – If True, get only complexes where all the genes participate together, otherwise get complexes where any of the genes participate.

Returns:

The filtered complexes.

Return type:

pandas.DataFrame