Render a simulation-study report

Renders a standard Quarto HTML report for a bayesim_simulation_result, covering the study design table, performance_measures(), parameter recovery plots per estimand, credible-interval coverage, and SBC rank ECDF panels (when a rank metric was computed). The report template lives at inst/report/simulation-report.qmd.

Each section is wrapped in tryCatch, so a missing metric (e.g. no rank data, no recorded truths) degrades gracefully instead of failing the whole render.

Requires the quarto R package AND the Quarto CLI. If the CLI is not available, an informative error is thrown pointing to https://quarto.org.

render_report() was previously named report(); the old name collided with the generic of the easystats report package and now lives on as a deprecated alias (see report()).

Usage

render_report(
  result,
  output_file = "bayesim-report.html",
  open = interactive()
)

Arguments

result

A bayesim_simulation_result from run_simulation().

output_file

Path to the rendered HTML output file (default "bayesim-report.html").

open

Logical scalar. When TRUE (the default in interactive sessions) the rendered report is opened in a viewer/browser. Forwarded to quarto::quarto_render() via its open handling where supported; on systems without that argument the file path is still returned.

Value

The path to the rendered HTML file (invisibly).

See also

performance_measures(), plot_recovery(), plot_coverage(), plot_rank_ecdf().

Examples

if (FALSE) { # \dontrun{
result <- run_simulation(config, progress = FALSE)
render_report(result, output_file = "my-study.html")
} # }