GenerateReport#

class causalpy.steps.report.GenerateReport[source]#

Pipeline step that generates an HTML report from pipeline results.

Parameters:

  • include_plots (bool) – Whether to include diagnostic plots in the report.

  • include_effect_summary (bool) – Whether to include the effect summary section.

  • include_sensitivity (bool) – Whether to include sensitivity analysis results.

  • output_file (str | Path | None) – If provided, write the HTML report to this file.

Examples

>>> import causalpy as cp
>>> step = cp.GenerateReport(
...     include_plots=True, output_file="report.html"
... )

Methods

GenerateReport.__init__([include_plots, ...])

GenerateReport.run(context)

Generate the HTML report and store it in the context.

GenerateReport.validate(context)

GenerateReport has no strict prerequisites; it gracefully handles missing data.
__init__(include_plots=True, include_effect_summary=True, include_sensitivity=True, output_file=None)[source]#
Parameters:

  • include_plots (bool)

  • include_effect_summary (bool)

  • include_sensitivity (bool)

  • output_file (str | Path | None)

Return type:

None

classmethod __new__(*args, **kwargs)#