SyntheticDifferenceInDifferences.plot#

SyntheticDifferenceInDifferences.plot(*, round_to=None, ci_prob=0.94, hdi_prob=None, kind='ribbon', ci_kind='hdi', num_samples=50, figsize=(7, 11), show=True, legend_kwargs=None)[source]#

Plot SDiD results: counterfactual, period impact, and cumulative impact.

Parameters:

  • round_to (int | None) – Number of decimals used to round the ATT in the title. Defaults to 2. Use None for raw values.

  • ci_prob (float) – Probability mass of the highest density interval drawn around the posterior predictive, causal impact, and cumulative impact bands. Must be in (0, 1]. Defaults to HDI_PROB (currently 0.94).

  • hdi_prob (float | None) – Deprecated. Use ci_prob instead.

  • kind (Literal['ribbon', 'histogram', 'spaghetti']) – How posterior uncertainty is rendered. Defaults to "ribbon" (mean + credible band).

  • ci_kind (Literal['hdi', 'eti']) – Credible interval type when kind="ribbon". Defaults to "hdi".

  • num_samples (int) – Number of posterior draws to overlay when kind="spaghetti". Defaults to 50.

  • figsize (tuple[float, float]) – Width and height of the figure in inches. Defaults to (7, 11) so the three panels and date tick labels have room.

  • show (bool) – Whether to call matplotlib.pyplot.show() after drawing. Defaults to True.

  • legend_kwargs (dict[str, Any] | None) – Keyword arguments applied to the top-axis legend in place after the figure is built. Supported keys include loc, bbox_to_anchor, fontsize, frameon, title, and optionally bbox_transform alongside bbox_to_anchor. See _render_plot().

Returns:

  • fig (matplotlib.figure.Figure) – The figure containing the three stacked panels (plotnine base plus matplotlib overlays for the treatment line and date formatting).

  • ax (numpy.ndarray) – Array of the three matplotlib.axes.Axes instances.

Return type:

tuple[Figure, ndarray]