*********************
autom8qc.qaqc.general
*********************

IncreasingTimeTest
==================

Class
-----

.. autoclass:: autom8qc.qaqc.general.IncreasingTimeTest
   :members:
   :show-inheritance:

Example
-------

.. code-block:: python

   # Generate sample data
   import datetime
   import numpy as np
   import pandas as pd
   np.random.seed(42)
   seconds = np.array([0, 60, 59, 183, 249, 309])
   date = datetime.datetime(year=2021, month=1, day=1)
   index = date + pd.to_timedelta(seconds, unit="s")
   series = pd.Series(np.random.rand(6) * 100, index=index)

   # Perform test and plot the results
   from autom8qc.qaqc.general import IncreasingTimeTest
   test = IncreasingTimeTest()
   test.plot(series=series, series_name="Example")

Visualization
-------------

.. figure:: ./figures/IncreasingTimeTest.svg
   :width: 100%

IsNaNTest
=========

Class
-----

.. autoclass:: autom8qc.qaqc.general.IsNaNTest
   :members:
   :show-inheritance:

Example
-------

.. code-block:: python

   # Generate sample data
   import numpy as np
   import pandas as pd
   mu, sigma = 50, 5
   values = np.random.normal(mu, sigma, 1000)
   values[[42, 100, 230, 456, 666, 667, 668]] = np.nan
   index = pd.date_range(start="1/1/2021", periods=1000, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.general import IsNaNTest
   test = IsNaNTest()
   probabilities = test.perform(series)
   print(probabilities)


SpecificValueTest
=================

Class
-----

.. autoclass:: autom8qc.qaqc.general.SpecificValueTest
   :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.randint(3, size=500)
   index = pd.date_range(start="1/1/2021", periods=500, freq="min")
   series = pd.Series(values, index=index)

   # Perform test
   from autom8qc.qaqc.general import SpecificValueTest
   test = SpecificValueTest(value=1, valid=True)
   test.plot(series=series, series_name="Example")


Visualization
-------------

.. figure:: ./figures/SpecificValueTest.svg
   :width: 100%

TimeGapsTest
============

Class
-----

.. autoclass:: autom8qc.qaqc.general.TimeGapsTest
   :members:
   :show-inheritance:

Example
-------

.. code-block:: python

   # Generate sample data
   import datetime
   import numpy as np
   import pandas as pd
   seconds = np.array([0, 60, 123, 183, 249, 309])
   date = datetime.datetime(year=2021, month=1, day=1)
   index = date + pd.to_timedelta(seconds, unit="s")
   series = pd.Series(np.random.rand(6) * 100, index=index)

   # Perform test
   from autom8qc.qaqc.general import TimeGapsTest
   test = TimeGapsTest(distance=60, delta=5)
   test.plot(series=series, series_name="Example")


Visualization
-------------

.. figure:: ./figures/TimeGapsTest.svg
   :width: 100%

TimeRangeTest
=============

Class
-----

.. autoclass:: autom8qc.qaqc.general.TimeRangeTest
   :members:
   :show-inheritance:

Example
-------

.. code-block:: python

   # Generate sample data
   from datetime import datetime
   import numpy as np
   import pandas as pd
   index = pd.date_range(start="1/1/2021", end="1/10/2021")
   series = pd.Series(np.random.rand(10) * 100, index=index)

   # Perform test
   from autom8qc.qaqc.general import TimeRangeTest
   test = TimeRangeTest(start=datetime(2021, 1, 3), end=datetime(2021, 1, 8))
   test.plot(series=series, series_name="Example")


Visualization
-------------

.. figure:: ./figures/TimeRangeTest.svg
   :width: 100%