NewEntry: Create new entry of benchmark results in the journal.

In nathansam/BenchJournal: Track Benchmark Results for a Package

Description

Uses microbenchmark to benchmark the scripts in man/BenchJournal/scripts and then adds the results to the journal file.

Usage

NewEntry(times = 10, warmup = 2, hash = NULL)

Arguments

times	The number of times to benchmark each script.
warmup	The warmup period. Defaults to 2. The first runs are typically much slower than the remaining runs due to the I/O operations invovled when reading the script(s). As such, using a warmup period is strongly advised. Bear in mind the total number of runs will be times + warmup, so a high value for warmup is not advised.
hash	The hash for a git committ. Used when the git hook workflow is being used. If you are a human, leave this as NULL.

nathansam/BenchJournal documentation built on June 21, 2020, 10:01 p.m.