EventStudy.effect_summary#

EventStudy.effect_summary(*, direction='increase', alpha=0.05, min_effect=None, include_pretrend_check=True, **kwargs)[source]#

Generate a decision-ready summary of causal effects for Event Study.

Returns the event-time coefficients table with a prose summary describing the pre-treatment trends (parallel trends check) and post-treatment effects.

Parameters:

  • direction (Literal['increase', 'decrease', 'two-sided']) – Direction for tail probability calculation (PyMC only, ignored for OLS).

  • alpha (float) – Significance level for HDI/CI intervals (1-alpha confidence level).

  • min_effect (float | None) – Region of Practical Equivalence (ROPE) threshold (PyMC only, ignored for OLS).

  • include_pretrend_check (bool) – Whether to include parallel trends analysis in prose summary.

  • **kwargs (Any) – Additional keyword arguments (currently unused, for API consistency).

Returns:

Object with .table (DataFrame) and .text (str) attributes

Return type:

EffectSummary