:mod:`memote.support.essentiality`
==================================

.. py:module:: memote.support.essentiality

.. autoapi-nested-parse::

   Supporting functions for stoichiometric consistency checks.

   ..
       !! processed by numpydoc !!



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


Functions
~~~~~~~~~

.. autoapisummary::

   memote.support.essentiality.confusion_matrix


.. data:: LOGGER
   

   

.. function:: confusion_matrix(predicted_essential, expected_essential, predicted_nonessential, expected_nonessential)

   Compute a representation of the confusion matrix.


   :Parameters:

       **predicted_essential** : set
           ..

       **expected_essential** : set
           ..

       **predicted_nonessential** : set
           ..

       **expected_nonessential** : set
           ..

   :Returns:

       dict
           Confusion matrix as different keys of a dictionary. The abbreviated
           keys correspond to the ones used in [Rfe356516a5f5-1]_.









   .. rubric:: References

   .. [Rfe356516a5f5-1] `Wikipedia entry for the Confusion matrix
          <https://en.wikipedia.org/wiki/Confusion_matrix>`_

   .. only:: latex

      [Rfe356516a5f5-1]_




   ..
       !! processed by numpydoc !!