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

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


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.epidemiology.time_range_based_metrics.TimeRangeBasedMetric
   rhino_health.lib.metrics.epidemiology.time_range_based_metrics.Prevalence
   rhino_health.lib.metrics.epidemiology.time_range_based_metrics.Incidence




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


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

   
   Abstract class for metrics that are based on a time range
















   ..
       !! 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:: time_column_name
      :type: rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName

      

   .. py:attribute:: start_time
      :type: str

      

   .. py:attribute:: end_time
      :type: str

      


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


   Bases: :py:obj:`TimeRangeBasedMetric`

   
   Returns the prevalence of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!

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


   Bases: :py:obj:`TimeRangeBasedMetric`

   
   Returns the incidence of entries for a specified VARIABLE
















   ..
       !! processed by numpydoc !!