Skip to content
Submodule
causalis.scenarios.synthetic_control.refutation.outcome_panel_plot

outcome_panel_plot

Submodule causalis.scenarios.synthetic_control.refutation.outcome_panel_plot with no child pages and 2 documented members.

Functions

Jump directly into the documented functions for this page.

1 items

Data

Jump directly into the documented data for this page.

1 items
function
causalis.scenarios.synthetic_control.refutation.outcome_panel_plot.outcome_panel_plot

outcome_panel_plot

Plot SCM panel outcomes over time.

The figure shows treated-unit outcomes over time, optional donor-unit paths, optional donor mean, and the intervention boundary.

Parameters

paneldataPanelDataSCM

Validated long-format panel contract.

show_donor_unitsbool, default True

If True, draw donor trajectories.

donor_max_linesint or None, default 20

Maximum number of donor-unit lines to draw. None draws all donors.

show_donor_meanbool, default True

If True, draw the donor-pool mean outcome path.

donor_alphafloat, default 0.35

Opacity for donor-unit lines.

donor_linewidthfloat, default 1.2

Line width for donor-unit lines.

shade_post_periodbool, default True

If True, lightly shade the post-treatment region.

figsizetuple, default (10.0, 5.5)

Figure size in inches.

dpiint, default 220

Dots per inch.

font_scalefloat, default 1.10

Font scaling factor.

savestr, optional

Optional path to save the figure.

save_dpiint, optional

DPI for saved raster outputs.

transparentbool, default False

Whether to save with a transparent background.

Returns

matplotlib.figure.Figure

The generated figure.

Canonical target

causalis.scenarios.synthetic_control.refutation.outcome_panel_plot.outcome_panel_plot

Sections

ParametersReturns
Link to this symbol
data
causalis.scenarios.synthetic_control.refutation.outcome_panel_plot.__all__

__all__

Value: ['outcome_panel_plot']

[‘outcome_panel_plot’]

Canonical target

causalis.scenarios.synthetic_control.refutation.outcome_panel_plot.__all__

Link to this symbol