es_report: One-Call Event Study Report Orchestrator
In EventStudy: Event Study Analysis

es_report

R Documentation

One-Call Event Study Report Orchestrator

Description

Generates a complete event study report in a single call: deep-clones the task (non-mutation guarantee, REPORT-04), harvests diagnostics via es_diagnostics(), and delegates rendering to generate_report(). Returns the output file path(s) VISIBLY so the path prints at the REPL without an explicit print().

Usage

es_report(
  task,
  output_file = "event_study_report.html",
  format = "html",
  sections = c("exec_summary", "data_methods", "results", "diagnostics", "robustness",
    "references"),
  provider = NULL,
  title = "Event Study Report",
  author = NULL,
  confidence_level = 0.95,
  interactive = TRUE,
  verbose = getOption("eventstudy.verbose", TRUE),
  ...
)

Arguments

`task`	A fitted `EventStudyTask` or `PanelEventStudyTask`.
`output_file`	Output file path (extension overridden per format). Default `"event_study_report.html"`.
`format`	Character vector of output formats, any subset of `c("html", "pdf", "word", "md")`. Default `"html"`. Multiple formats render one file per format sharing a common basename.
`sections`	Character vector of sections to include. Default is all six fixed sections: `c("exec_summary","data_methods","results","diagnostics","robustness","references")`.
`provider`	Optional LLM provider forwarded to `generate_report()`. When `NULL` (default), renders a fully offline report (no API key, no network required).
`title`	Report title string.
`author`	Author name (optional, default `NULL` -> `""`).
`confidence_level`	Confidence level for plots. Default 0.95.
`interactive`	Logical. Use interactive plotly plots in HTML output. Default `TRUE`.
`verbose`	Logical; if FALSE, suppress informational messages. Default `getOption("eventstudy.verbose", TRUE)`.
`...`	Additional arguments forwarded to `generate_report()` and on to `rmarkdown::render`.

Details

The narrative is assembled ONCE inside generate_report() (NARR-01): es_report() does NOT call assemble_report_narrative() or es_advise() directly. A provider argument is forwarded to generate_report(), which assembles the narrative once before the format loop. When provider = NULL (default), the report is fully offline with no network or API key required.

Value

A named character vector of output file path(s), one per rendered format, returned visibly (the path prints at the REPL). Keyed by format name, e.g. c(html = "/tmp/report.html"). A single-format call returns a length-1 named vector; result[["html"]] and result[[1L]] both resolve.

Examples


data(dieselgate)
task <- EventStudyTask$new(dieselgate$firm, dieselgate$index, dieselgate$request)
task <- run_event_study(task, ParameterSet$new())

# Offline single-format report written to a temporary directory
out  <- file.path(tempdir(), "event_study_report.html")
path <- es_report(task, output_file = out, format = "html")
path[["html"]]

EventStudy documentation built on Oct. 31, 2026, 1:07 a.m.