benchGetter: benchGetter

Description Usage Arguments Value

Description

Retrieves information stored in package environment, such as benchmark or profiling records, systemId, runId, meta information.

Usage

1
2
3
4
benchGetter(target = c("id", "benchmarks", "profile", "profilerun",
  "systemid", "runid", "file", "runs", "run_ok", "timed_fun", "bench_version",
  "meta", "computetime"), idxCol = NULL, retCol = NULL, fltVal = NULL,
  fltRunId = NULL, file = NULL, runId = NULL)

Arguments

target

which information to retrieve target: benchmarks: returns table with all recorded benchmarks. profile: returns 'retCol' from PROFILES where 'idxCol' == 'fltVal'. profilerun: returns PROFILES table subsetted with runId. warnings: returns ExecEnvironment$WARNINGS data.frame containing all warnings recorded. systemid: returns the unique systemId that is used to identify this system.

idxCol

profiling records will be filtered based on content of this column

retCol

content of this column will be returned after filtering

fltVal

this value will be compared to indexCol to filter profiling records

fltRunId

which runId to use for filtering profiling records

file

input R script to benchmark.

runId

character(18) long Id generated for this run.

Value

depending on target choice, either a vector or data frame


psolaimani/benchmaRk documentation built on May 26, 2019, 11:30 a.m.