Deprecated alias for render_report()

report() was renamed to render_report() because the old name collided with the generic of the easystats report package. The alias forwards to render_report() and emits a deprecation warning once per session; it will be removed in a future release.

Usage

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

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.
estimands: Ignored. The argument was accepted (and documented as informational only) by report() but never used; it is kept in the signature purely so existing calls do not error.