Skip to content
Submodule
causalis.scenarios.gate.gate_plot

gate_plot

Submodule causalis.scenarios.gate.gate_plot with no child pages and 3 documented members.

Functions

Jump directly into the documented functions for this page.

1 items

Data

Jump directly into the documented data for this page.

2 items
function
causalis.scenarios.gate.gate_plot.gate_plot

gate_plot

Plot effect estimates with confidence intervals for a single estimate or group-level estimates such as GATE/GATET.

Parameters

estimateCausalEstimate or GateEstimate

Estimate object to visualize. GateEstimate produces one point per group regardless of whether the estimand is GATE or GATET; CausalEstimate produces a single-row forest plot.

axmatplotlib.axes.Axes, optional

Existing axes to draw on.

figsizetuple of float, optional

Figure size. If omitted, a height is chosen automatically from the number of plotted rows.

dpiint, default 220

Figure DPI.

font_scalefloat, default 1.0

Multiplicative scale for text sizes.

colorstr, default “C0”

Marker and interval color.

zero_line_colorstr, default “0.5”

Reference line color for zero effect.

labelstr, optional

Row label used when plotting a single CausalEstimate.

xlabelstr, default “Effect”

X-axis label.

titlestr, optional

Plot title. Defaults depend on the estimate type.

savestr, optional

Optional output path for saving the figure.

save_dpiint, optional

DPI for saved raster output.

transparentbool, default False

Whether to save with a transparent background.

Canonical target

causalis.scenarios.gate.gate_plot.gate_plot

Sections

Parameters
Link to this symbol
data
causalis.scenarios.gate.gate_plot.plot_gate_estimate

plot_gate_estimate

Value: None

None

Canonical target

causalis.scenarios.gate.gate_plot.plot_gate_estimate

Link to this symbol
data
causalis.scenarios.gate.gate_plot.__all__

__all__

Value: ['gate_plot', 'plot_gate_estimate']

[‘gate_plot’, ‘plot_gate_estimate’]

Canonical target

causalis.scenarios.gate.gate_plot.__all__

Link to this symbol