HierarchicalInterruptedTimeSeries.effect_summary#

HierarchicalInterruptedTimeSeries.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]#

Return a compact summary of the population-level effect.

Reports posterior mean and HDI for mu_lift (instant) or each mu_delta bin (event-study / placebo).

Parameters:

  • window (Literal['post'] | tuple | slice)

  • direction (Literal['increase', 'decrease', 'two-sided'])

  • alpha (float)

  • cumulative (bool)

  • relative (bool)

  • min_effect (float | None)

  • treated_unit (str | None)

  • period (Literal['intervention', 'post', 'comparison'] | None)

  • prefix (str)

  • kwargs (Any)

Return type:

EffectSummary