begin: Initialise an autobenchR run.
In bjmt/autobenchR: Automated code benchmarking

Description Usage Arguments Value Author(s)

Generates the settings used by instances of autobenchR::run(). This function must be called before any other, and again after autobenchR::end() is called in order to run further benchmarks.

begin(file = stdout(), name = NULL, quiet = ifelse(isatty(file),
  TRUE, FALSE), tool = "rbenchmark", min.reps = 1, max.reps = 100,
  min.time = 0.5, check = FALSE, unit = "t", stop.on.fail = FALSE,
  format = ifelse(isatty(file), "txt", "md"),
  session.info = ifelse(isatty(file), FALSE, TRUE))

`file`	Print results to this file. The default (`file = stdout()`) prints results to the terminal.
`name`	Name of autobenchR session.
`quiet`	Suppress run status. By default, is set to `TRUE` if `file` is a terminal connection and `FALSE` otherwise.
`tool`	Benchmarking package used by autobenchR. One of "bench", "microbenchmark", and "rbenchmark".
`min.reps`	Only applies if `tool = "bench"`. Minimum number of times to run each expression.
`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).
`check`	Make sure all expressions in a run return equal values. Only valid if `tool = "bench"` or `tool = "microbenchmark"`.
`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.
`stop.on.fail`	Whether to give an error if one of the expressions gives an error, or continue.
`format`	Format of output results. One of "txt" (text) and "md" (markdown). Defaults to "txt" if `file` is a terminal connection.
`session.info`	Print session info after `autobenchR::end()` is called. By default will only be set to `TRUE` if `file` is not a terminal connection.