:py:mod:`causal_testing.estimation.effect_estimate`
===================================================

.. py:module:: causal_testing.estimation.effect_estimate

.. autoapi-nested-parse::

   This module contains the EffectEstimate dataclass.



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

Classes
~~~~~~~

.. autoapisummary::

   causal_testing.estimation.effect_estimate.EffectEstimate




.. py:class:: EffectEstimate


   A dataclass to hold the value and confidence intervals of a causal effect estimate

   :ivar type: The type of estimate, e.g. ate, or risk_ratio
               (used to determine whether the estimate matches the expected effect)
   :ivar value: The estimated causal effect
   :ivar ci_low: The lower confidence interval
   :ivar ci_high: The upper confidence interval

   .. py:attribute:: type
      :type: str

      

   .. py:attribute:: value
      :type: pandas.Series

      

   .. py:attribute:: ci_low
      :type: pandas.Series

      

   .. py:attribute:: ci_high
      :type: pandas.Series

      

   .. py:method:: ci_valid() -> bool

      Return whether or not the result has valid confidence invervals


   .. py:method:: to_dict() -> dict

      Return representation as a dict.


   .. py:method:: to_df() -> pandas.DataFrame

      Return representation as a pandas dataframe.