:py:mod:`rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics`
==============================================================================

.. py:module:: rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.TwoByTwoTableBasedMetric
   rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.TwoByTwoTable
   rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.OddsRatio
   rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.Odds
   rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.Risk
   rhino_health.lib.metrics.epidemiology.two_by_two_table_based_metrics.RiskRatio




.. py:class:: TwoByTwoTableBasedMetric(**kwargs)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`, :py:obj:`abc.ABC`

   
   Abstract class for metrics that are based on a two by two table
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: detected_column_name
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: exposed_column_name
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      


.. py:class:: TwoByTwoTable(**kwargs)


   Bases: :py:obj:`TwoByTwoTableBasedMetric`

   
   Returns the two by two table of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!
   .. py:property:: metric_response

      
      Returns the response class for the metric
















      ..
          !! processed by numpydoc !!


.. py:class:: OddsRatio(**kwargs)


   Bases: :py:obj:`TwoByTwoTableBasedMetric`

   
   Returns the odds ratio of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!

.. py:class:: Odds(**kwargs)


   Bases: :py:obj:`rhino_health.lib.metrics.base_metric.AggregatableMetric`

   
   Returns the odds of entries for a specified VARIABLE where the odd is calculated by the ratio of the number of true
    occurrences to the number of false occurrences.
















   ..
       !! processed by numpydoc !!
   .. py:attribute:: variable
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: column_name
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      


.. py:class:: Risk(**kwargs)


   Bases: :py:obj:`TwoByTwoTableBasedMetric`

   
   Returns the risk of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!

.. py:class:: RiskRatio(**kwargs)


   Bases: :py:obj:`TwoByTwoTableBasedMetric`

   
   Returns the risk ratio of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!