:py:mod:`rhino_health.lib.metrics.basic`
========================================

.. py:module:: rhino_health.lib.metrics.basic


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

Classes
~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.basic.Count
   rhino_health.lib.metrics.basic.Mean
   rhino_health.lib.metrics.basic.StandardDeviation
   rhino_health.lib.metrics.basic.Sum




Attributes
~~~~~~~~~~

.. autoapisummary::

   rhino_health.lib.metrics.basic.COMMON_METRICS


.. py:class:: Count(**data)


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

   
   Returns the count of entries for a specified VARIABLE
















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

      

   .. py:attribute:: join_mode
      :type: Optional[JoinMode]

      
       The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: join_field
      :type: Optional[rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName]

      
       A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)
















      ..
          !! processed by numpydoc !!


.. py:class:: Mean(**data)


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

   
   Returns the mean value of a specified VARIABLE
















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

      

   .. py:attribute:: join_mode
      :type: Optional[JoinMode]

      
       The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: join_field
      :type: Optional[rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName]

      
       A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)
















      ..
          !! processed by numpydoc !!


.. py:class:: StandardDeviation(**data)


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

   
   Returns the standard deviation of a specified VARIABLE
















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

      

   .. py:attribute:: join_mode
      :type: Optional[JoinMode]

      
       The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: join_field
      :type: Optional[rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName]

      
       A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)
















      ..
          !! processed by numpydoc !!


.. py:class:: Sum(**data)


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

   
   Returns the sum of a specified VARIABLE
















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

      

   .. py:attribute:: join_mode
      :type: Optional[JoinMode]

      
       The mode to perform an optional Federated Join in. Defaults to intersection if join_field, query_datasets, or filter_datasets are defined
















      ..
          !! processed by numpydoc !!

   .. py:attribute:: join_field
      :type: Optional[rhino_health.lib.metrics.filter_variable.FilterVariableTypeOrColumnName]

      
       A field to perform a join on if performing a Federated Join. This filter_variable will be performed on the filter_dataset(s)
















      ..
          !! processed by numpydoc !!


.. py:data:: COMMON_METRICS