press() is used to run bench::mark() across a grid of parameters and then press the results together.

The parameters you want to set are given as named arguments and a grid of all possible combinations is automatically created.

The code to setup and benchmark is given by one unnamed expression (often delimited by {).

If replicates are desired a dummy variable can be used, e.g. rep = 1:5 for replicates.

press(..., .grid = NULL)

Arguments

...

If named, parameters to define, if unnamed the expression to run. Only one unnamed expression is permitted.

.grid

A pre-build grid of values to use, typically a data.frame or tibble. This is useful if you only want to use a subset of all possible combinations.

Examples

# Helper function to create a simple data.frame of the specified dimensions create_df <- function(rows, cols) { as.data.frame(setNames( replicate(cols, runif(rows, 1, 1000), simplify = FALSE), rep_len(c("x", letters), cols))) } # Run 4 data sizes across 3 samples with 2 replicates (24 total benchmarks) press( rows = c(1000, 10000), cols = c(10, 100), rep = 1:2, { dat <- create_df(rows, cols) bench::mark( min_time = .05, bracket = dat[dat$x > 500, ], which = dat[which(dat$x > 500), ], subset = subset(dat, x > 500) ) } )
#> Running with: #> rows cols rep
#> 1 1000 10 1
#> 2 10000 10 1
#> 3 1000 100 1
#> 4 10000 100 1
#> 5 1000 10 2
#> 6 10000 10 2
#> 7 1000 100 2
#> 8 10000 100 2
#> # A tibble: 24 x 17 #> expression rows cols rep min mean median max `itr/sec` #> * <chr> <dbl> <dbl> <int> <bch:tm> <bch:tm> <bch:tm> <bch:tm> <dbl> #> 1 bracket 1000 10 1 105.48µs 130.31µs 120.22µs 978.83µs 7674. #> 2 which 1000 10 1 101.05µs 127.8µs 111.2µs 1ms 7825. #> 3 subset 1000 10 1 128.24µs 157.18µs 143.14µs 878.94µs 6362. #> 4 bracket 10000 10 1 808.75µs 1.1ms 953.35µs 1.81ms 906. #> 5 which 10000 10 1 463.57µs 634.79µs 581.99µs 1.45ms 1575. #> 6 subset 10000 10 1 901.8µs 1.04ms 973.51µs 1.62ms 957. #> 7 bracket 1000 100 1 785.25µs 1.03ms 880.2µs 1.66ms 974. #> 8 which 1000 100 1 660.08µs 796.61µs 749.66µs 1.51ms 1255. #> 9 subset 1000 100 1 809.87µs 1.02ms 892.4µs 1.66ms 981. #> 10 bracket 10000 100 1 8.33ms 9.11ms 8.64ms 10.35ms 110. #> # ... with 14 more rows, and 8 more variables: mem_alloc <bch:byt>, n_gc <dbl>, #> # n_itr <int>, total_time <bch:tm>, result <list>, memory <list>, #> # time <list>, gc <list>