.. _autom8qc.rules:

**************
autom8qc.rules
**************

autom8qc.rules.base
===================

.. automodule:: autom8qc.rules.base
   :members:

autom8qc.rules.frequency
========================


autom8qc.rules.frequency.InvalidFrequencyRule
---------------------------------------------

Class
^^^^^
.. autoclass:: autom8qc.rules.frequency.InvalidFrequencyRule
   :members:
   :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   from autom8qc.core.validities import StandardValidities

   np.random.seed(42)
   validities = StandardValidities()
   ids = np.random.randint(4, size=50)
   values = np.array([validities.ALL_VALIDITIES[id] for id in ids])
   values[10:20] = validities.ERRONEOUS
   index = pd.date_range(start="1/1/2021", periods=50, freq="1min")
   series = pd.Series(values, index=index)

   from autom8qc.rules.frequency import InvalidFrequencyRule
   rule = InvalidFrequencyRule(rel_frequency=0.1)
   rule.plot(series)


Visualization
^^^^^^^^^^^^^

.. figure:: ./rules/InvalidFrequencyRule.svg
   :width: 100%


autom8qc.rules.frequency.LowerFrequencyRule
-------------------------------------------

Class
^^^^^
.. autoclass:: autom8qc.rules.frequency.LowerFrequencyRule
   :members:
   :show-inheritance:

Example
^^^^^^^

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd

   np.random.seed(42)
   values = np.random.random(50)
   values[10:20] = 0
   index = pd.date_range(start="1/1/2021", periods=50, freq="1min")
   series = pd.Series(values, index=index)

   from autom8qc.rules.frequency import LowerFrequencyRule
   rule = LowerFrequencyRule(threshold=0.1, rel_frequency=0.1)
   rule.plot(series)


Visualization
^^^^^^^^^^^^^

.. figure:: ./rules/LowerFrequencyRule.svg
   :width: 100%