causalis.scenarios.gate.gate_plot¶
Module Contents¶
Functions¶
Plot effect estimates with confidence intervals for a single estimate or group-level estimates such as GATE/GATET. |
Data¶
API¶
- causalis.scenarios.gate.gate_plot.gate_plot(estimate: causalis.data_contracts.causal_estimate.CausalEstimate | causalis.data_contracts.gate_estimate.GateEstimate, ax: Optional[matplotlib.pyplot.Axes] = None, figsize: Optional[Tuple[float, float]] = None, dpi: int = 220, font_scale: float = 1.0, color: str = 'C0', zero_line_color: str = '0.5', label: Optional[str] = None, xlabel: str = 'Effect', title: Optional[str] = None, save: Optional[str] = None, save_dpi: Optional[int] = None, transparent: bool = False) matplotlib.pyplot.Figure¶
Plot effect estimates with confidence intervals for a single estimate or group-level estimates such as GATE/GATET.
Parameters
estimate : CausalEstimate or GateEstimate Estimate object to visualize.
GateEstimateproduces one point per group regardless of whether the estimand isGATEorGATET;CausalEstimateproduces a single-row forest plot. ax : matplotlib.axes.Axes, optional Existing axes to draw on. figsize : tuple of float, optional Figure size. If omitted, a height is chosen automatically from the number of plotted rows. dpi : int, default 220 Figure DPI. font_scale : float, default 1.0 Multiplicative scale for text sizes. color : str, default “C0” Marker and interval color. zero_line_color : str, default “0.5” Reference line color for zero effect. label : str, optional Row label used when plotting a singleCausalEstimate. xlabel : str, default “Effect” X-axis label. title : str, optional Plot title. Defaults depend on the estimate type. save : str, optional Optional output path for saving the figure. save_dpi : int, optional DPI for saved raster output. transparent : bool, default False Whether to save with a transparent background.
- causalis.scenarios.gate.gate_plot.plot_gate_estimate¶
None
- causalis.scenarios.gate.gate_plot.__all__¶
[‘gate_plot’, ‘plot_gate_estimate’]