benchmark_analyze: Turn raw benchmark results into text and figures

In lorenzwalthert/touchstone: Continuous Benchmarking with Statistical Confidence Based on 'Git' Branches

Turn raw benchmark results into text and figures

Description

Turn raw benchmark results into text and figures

Usage

benchmark_analyze(
  branches = c(branch_get_or_fail("GITHUB_BASE_REF"),
    branch_get_or_fail("GITHUB_HEAD_REF")),
  names = NULL,
  ci = 0.95
)

Arguments

branches	The names of the branches for which analysis should be created.
names	The names of the benchmarks to analyze. If NULL, all benchmarks with the branches are taken.
ci	The confidence level, defaults to 95%.

Details

Creates two side effects:

• Density plots for each element in branches are written to touchstone/plots.

• A text explaining the speed diff is written to touchstone/pr-comment/info.txt for every registered benchmarking expression. See vignette("inference", package = "touchstone") for details.

Requires dplyr::dplyr, ggplot2::ggplot2 and glue::glue.

Value

A character vector that summarizes the benchmarking results.

lorenzwalthert/touchstone documentation built on April 20, 2024, 9:57 a.m.