Format an adoption benchmark report

format_benchmark_report() turns a benchmark object or result table into Markdown sections that can be used in an investigation note, package site, or manuscript supplement. The report deliberately includes comparator availability and caveats so benchmark claims remain tied to the estimand and local software environment.

Usage

format_benchmark_report(
  benchmark,
  title = "gamlss.longitudinal Adoption Benchmark Report",
  comparator_status = benchmark_comparator_status(),
  metrics = NULL,
  include_case_results = FALSE,
  max_case_rows = 100L,
  digits = 3
)

Arguments

benchmark

A gamlss_longitudinal_adoption_benchmark object from run_adoption_benchmarks() or a results data frame accepted by summarise_benchmark_results().

title

Report title.

comparator_status

Optional comparator availability table. Defaults to benchmark_comparator_status().

metrics

Optional metric vector used when benchmark is a raw results data frame.

include_case_results

Logical; include per-case win/tie/loss rows.

max_case_rows

Maximum case rows to include when include_case_results = TRUE.

digits

Significant digits for numeric report tables.

Value

A character vector containing Markdown lines.