:py:mod:`respy.pre_processing.data_checking`
============================================

.. py:module:: respy.pre_processing.data_checking

.. autoapi-nested-parse::

   Test functions to ensure the validity of data.

   ..
       !! processed by numpydoc !!


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


Functions
~~~~~~~~~

.. autoapisummary::

   respy.pre_processing.data_checking.check_estimation_data
   respy.pre_processing.data_checking.check_simulated_data



.. py:function:: check_estimation_data(df, optim_paras)

   
   Check data for estimation.


   :Parameters:

       **optim_paras** : :class:`python:dict`
           Dictionary containing model optim_paras.

       **df** : :obj:`pandas.DataFrame`
           Data for estimation.





   :Raises:

       :obj:`AssertionError`
           If data has not the expected format.









   ..
       !! processed by numpydoc !!

.. py:function:: check_simulated_data(optim_paras, df)

   
   Check simulated data.

   This routine runs some consistency checks on the simulated dataset. Some more
   restrictions are imposed on the simulated dataset than the observed data.















   ..
       !! processed by numpydoc !!