Write an adoption benchmark report

Usage

write_benchmark_report(
  benchmark,
  path = file.path("results", "adoption_benchmarks", "adoption_benchmark_report.md"),
  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().
path: Markdown output path.
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

The normalized report path, invisibly.