SyntheticControl.effect_summary#

SyntheticControl.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 for Synthetic Control.

Parameters:

  • window (Union[Literal['post'], tuple, slice]) – Time window for analysis: - “post”: All post-treatment time points (default) - (start, end): Tuple of start and end times (handles both datetime and integer indices) - slice: Python slice object for integer indices

  • 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).

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

  • relative (bool) – Whether to include relative effect statistics (% change vs counterfactual).

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

  • treated_unit (str | None) – For multi-unit experiments, specify which treated unit to analyze. If None and multiple units exist, uses first unit.

  • period (Optional[Literal['intervention', 'post', 'comparison']]) – Ignored for Synthetic Control (two-period design only).

  • prefix (str) – Prefix for prose generation. Defaults to “Post-period”.

  • kwargs (Any)

Returns:

Object with .table (DataFrame) and .text (str) attributes. The .text attribute contains a detailed multi-paragraph narrative report.

Return type:

EffectSummary