benchmarkSource: Simple Benchmark/Profiling Tool For R Scripts

Description Usage Arguments Details Value Author(s)

Description

This script will benchmark the running time of the given input file. Time used by functions defined in timed_fun data frame will be subtracted from total running time. This benchmarking tools differs to other benchmarking tools in that it times the running time of longer R scripts in a defined environment by allowing (version)control over input data, used packages and scriptfile.

Usage

1
benchmarkSource(file, timed_fun, runs, loc.src, uses_packrat, bench_log, warn_log)

Arguments

file

R script to benchmark

timed_fun

a data frame whith 4 columns. Column 1: function; column 2: package; column 3: process category eg. READ/WRITE but never BENCHMARK; column 4: function type, currently only 'IO'.

runs

(integer) number of pre-runs which are not timed but serve to measure warm running time of the last run.

loc.src

chracter vector containing location of CRAN like repository which contains the source code (package_version.tar.gz) of used package versions

uses_packrat

use if you have packified your script using packrat. Default is TRUE

bench_log

filename to use to store message/warning/errors. Default is "benchmark.log"

warn_log

level of logging to use (choose from -1, "INFO", "WARN", "STOP". Default value is -1.

Details

benchmarkSource

Value

returns a dubble with running time of last benchmark

Author(s)

Parham Solaimani (Maintainer)

Maarten-Jan Kallen

Alexander Bertram


psolaimani/BenchmarkR documentation built on May 26, 2019, 10:36 a.m.