StaggeredDifferenceInDifferences.generate_report#

StaggeredDifferenceInDifferences.generate_report(*, include_plots=True, include_effect_summary=True, output_file=None)#

Generate a self-contained HTML report for this experiment.

This is a convenience wrapper around GenerateReport that does not require a full pipeline.

Parameters:

  • include_plots (bool) – Embed diagnostic plots in the report.

  • include_effect_summary (bool) – Include the effect-summary section.

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

Returns:

The rendered HTML report.

Return type:

str