Skip to contents

Compare immutable scientific benchmark records, select historical baselines, and produce deterministic source-only or Quarto-rendered scientific regression reports. Performance components use baseline-aware resource comparisons when machine fingerprints are compatible; other components retain transparent digest-change records rather than claiming numerical equivalence.

Usage

compare_release_benchmarks(current, baseline)

release_comparison_table(x)

latest_release_benchmark(archive, exclude = character())

write_regression_report(
  archive,
  output_dir,
  comparison = NULL,
  render = TRUE,
  title = "popgenVCF scientific regression report"
)

Arguments

current, baseline

Validated PopgenVCFReleaseBenchmarkRecord objects.

x

A PopgenVCFReleaseComparison.

archive

A PopgenVCFBenchmarkArchive, or for report writing an archive directory.

exclude

Release identifiers excluded from latest-release selection.

output_dir

Destination directory for source tables, report data, QMD, and optional HTML.

comparison

Optional release comparison.

render

Whether to render HTML when Quarto is installed.

title

Report title.

Value

compare_release_benchmarks() returns a PopgenVCFReleaseComparison. release_comparison_table() returns a data table. latest_release_benchmark() returns a release record. write_regression_report() returns a named list of generated paths.