update: Change autobenchR settings during a run.

Description Usage Arguments Value Author(s)

Description

Changes the benchmark settings partway through an autobenchR session.

Usage

1
2
3
update(max.reps = NULL, min.time = NULL, unit = NULL, check = NULL,
  min.reps = NULL, tool = NULL, stop.on.fail = NULL,
  permanent = FALSE)

Arguments

max.reps

If tool = "bench", the maximum number of times to run each expression. If tool = "microbenchmark" or tool = "rbenchmark", the exact number of times to run each expression.

min.time

Only applies if tool = "bench". Minimum time in seconds to each expression (unless expression has already been run max.reps times).

unit

Only applies if tool = "microbenchmark" or tool = "rbenchmark". Units to show in benchmarking results tables. See microbenchmark::microbenchmark() for acceptable units when tool = "microbenchmark". When tool = "rbenchmark", acceptable units are "ns" (nanoseconds), "us" (microseconds), "ms" (milliseconds), "s" (seconds), and "min" (minutes). The default, unit = "t", when run with tool = "microbenchmark" will automatically pick a unit; and when run with tool = "rbenchmark", seconds are used.

check

Make sure all expressions in a run return equal values. Only valid if tool = "bench" or tool = "microbenchmark".

min.reps

Only applies if tool = "bench". Minimum number of times to run each expression.

tool

Benchmarking package used by autobenchR. One of "bench", "microbenchmark", and "rbenchmark".

stop.on.fail

Whether to give an error if one of the expressions gives an error, or continue.

permanent

Whether to only change the settings of the next immediate set of benchmarks, or all following benchmarks. Note that only one set of updated settings are stored, so calling autobenchR::update() again will overwrite these.

Value

NULL, invisibly.

Author(s)

Benjamin Jean-Marie Tremblay


bjmt/autobenchR documentation built on May 7, 2019, 12:51 a.m.