boxplot.benchmark {benchr}

Boxplot method for the benchmark timings

Description

Displays measurement results as box plots, with R expressions on X axis and execution time on Y axis.

Usage

## S3 method for class 'benchmark'
boxplot(
  x,
  units = "auto",
  log = TRUE,
  xlab,
  ylab,
  horizontal = FALSE,
  violin = FALSE,
  ...
)

Arguments

x

An object of class benchmark.

units

Character. The units to be used in printing the timings. The available units are nanoseconds ("ns"), microseconds ("us"), milliseconds ("ms"), seconds ("s").

log

Logical. Should times be plotted on log scale?

xlab

Character. X axis label.

ylab

Character. Y axis label.

horizontal

Logical. If set to TRUE, X and Y axes will be switched. Defaults to FALSE.

violin

Logical. Use ggplot2::geom_violin() instead ggplot2::geom_boxplot() for the ggplot plots.

...

Arguments passed on to boxplot.default().

Details

If ggplot2 package is available, it will be used. In order to switch to default boxplot from the graphics package set option benchr.use_ggplot to FALSE: options(benchr.use_ggplot = FALSE).

Author(s)

Artem Klevtsov [e-mail]

See Also

plot.benchmark()

Examples

timings <- benchmark(
  rchisq(100, 0), rchisq(100, 1), rchisq(100, 2),
  rchisq(100, 3), rchisq(100, 5),
  times = 1000L
)
boxplot(timings)