run_one: Run a Benchmark with a single set of parameters
In ursa-labs/arrowbench: Tools for Continuous and Interactive Benchmarking

run_one

R Documentation

Run a Benchmark with a single set of parameters

Description

Run a Benchmark with a single set of parameters

Usage

run_one(
  bm,
  ...,
  n_iter = 1,
  batch_id = NULL,
  dry_run = FALSE,
  profiling = FALSE,
  progress_bar = NULL,
  read_only = FALSE,
  run_id = NULL,
  run_name = NULL,
  run_reason = NULL,
  test_packages = NULL
)

Arguments

`bm`	`Benchmark()` object
`...`	parameters passed to `bm$setup()` or global parameters; see the "Parameterizing benchmarks" section of `Benchmark()`
`n_iter`	Integer number of iterations to replicate each benchmark
`batch_id`	a length 1 character vector to identify the batch
`dry_run`	logical: just return the R source code that would be run in a subprocess? Default is `FALSE`, meaning that the benchmarks will be run.
`profiling`	Logical: collect prof info? If `TRUE`, the result data will contain a `prof_file` field, which you can read in with `profvis::profvis(prof_input = file)`. Default is `FALSE`
`progress_bar`	a `progress` object to update progress to (default `NULL`)
`read_only`	this will only attempt to read benchmark files and will not run any that it cannot find.
`run_id`	Unique ID for the run
`run_name`	Name for the run
`run_reason`	Low-cardinality reason for the run, e.g. "commit" or "test"
`test_packages`	a character vector of packages that the benchmarks test (default `NULL`)