:py:mod:`causal_testing.utils.validation`
=========================================

.. py:module:: causal_testing.utils.validation

.. autoapi-nested-parse::

   This module contains the CausalValidator class for performing Quantitive Bias Analysis techniques



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

Classes
~~~~~~~

.. autoapisummary::

   causal_testing.utils.validation.CausalValidator




.. py:class:: CausalValidator


   A suite of validation tools to perform Quantitive Bias Analysis to back up causal claims

   .. py:method:: estimate_robustness(model: statsmodels.regression.linear_model.RegressionResultsWrapper, q=1, alpha=1)
      :staticmethod:

      Calculate the robustness of a linear regression model. This allow
      the user to identify how large an unidentified confounding variable
      would need to be to nullify the causal relationship under test.


   .. py:method:: estimate_e_value(risk_ratio: float) -> float
      :staticmethod:

      Calculate the E value from a risk ratio. This allow
      the user to identify how large a risk an unidentified confounding
      variable would need to be to nullify the causal relationship
      under test.


   .. py:method:: estimate_e_value_using_ci(risk_ratio: float, confidence_intervals: tuple[float, float]) -> float
      :staticmethod:

      Calculate the E value from a risk ratio and it's confidence intervals.
      This allow the user to identify how large a risk an unidentified
      confounding variable would need to be to nullify the causal relationship
      under test.