micom.interaction.scores
========================

.. py:module:: micom.interaction.scores

.. autoapi-nested-parse::

   Various interaction scores.



Functions
---------

.. autoapisummary::

   micom.interaction.scores._mes
   micom.interaction.scores.MES


Module Contents
---------------

.. py:function:: _mes(df: pandas.DataFrame) -> float

   Helper to calculate the MES score.


.. py:function:: MES(results: micom.workflows.GrowthResults, cutoff: float = None) -> pandas.DataFrame

   Calculate the Metabolic Exchange Score (MES) for each metabolite.

   MES is the harmonic mean of producers and consumers for a chosen metabolite
   in one sample. High values indicate a large prevalence of cross-feeding for the
   particular metabolite. A value of zero indicates an absence of cross-feeding for
   the particular metabolite.

   :param results: The growth results to use.
   :type results: GrowthResults
   :param cutoff: The smallest flux to consider in the analysis. Will default to the
                  solver tolerance if set to None.
   :type cutoff: float

   :returns: The scores for each metabolite and each sample including metabolite annotations.
   :rtype: pandas.DataFrame

   .. rubric:: References

   .. [1] Marcelino, V.R., et al.
          Disease-specific loss of microbial cross-feeding interactions in the human gut
          Nat Commun 14, 6546 (2023). https://doi.org/10.1038/s41467-023-42112-w