InstrumentalVariable.effect_summary#

InstrumentalVariable.effect_summary(*, window='post', direction='increase', alpha=0.05, cumulative=True, relative=True, min_effect=None, treated_unit=None, period=None, prefix='Post-period', **kwargs)[source]#

Generate a decision-ready summary of causal effects.

Note: effect_summary is not yet implemented for InstrumentalVariable experiments.

Parameters:

  • window (Union[Literal['post'], tuple, slice]) – Time window for analysis (unused for InstrumentalVariable).

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

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

  • cumulative (bool) – Whether to include cumulative effect statistics.

  • relative (bool) – Whether to include relative effect statistics.

  • min_effect (float | None) – Region of Practical Equivalence (ROPE) threshold.

  • treated_unit (str | None) – For multi-unit experiments, the unit to analyse.

  • period (Optional[Literal['intervention', 'post', 'comparison']]) – Period selector for three-period designs.

  • prefix (str) – Prefix for prose generation.

  • **kwargs (Any) – Reserved for forward-compatibility.

Return type:

EffectSummary