causal_testing.estimation.effect_estimate

This module contains the EffectEstimate dataclass.

Module Contents

Classes

EffectEstimate

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

class causal_testing.estimation.effect_estimate.EffectEstimate

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

Variables:
  • type – The type of estimate, e.g. ate, or risk_ratio (used to determine whether the estimate matches the expected effect)

  • value – The estimated causal effect

  • ci_low – The lower confidence interval

  • ci_high – The upper confidence interval

type: str
value: pandas.Series
ci_low: pandas.Series
ci_high: pandas.Series
ci_valid() bool

Return whether or not the result has valid confidence invervals

to_dict() dict

Return representation as a dict.

to_df() pandas.DataFrame

Return representation as a pandas dataframe.