time_compare: Run-time across versions.

In analyticalmonk/Rperform: Rperform - Performance testing for R packages

Run-time across versions.

Description

Given a test-file path, checks its run-time against the specified number of commits in the current git repository and returns a data-frame comprised of the test name, status of test run, time (if successful) and SHA1 value corresponding to the commit the value is for.

Usage

time_compare(test_path, num_commits = 10)

Arguments

test_path	File-path of the test-file which is to be used for run-time comparisons.
num_commits	Number of commits (versions) against which the file is to be tested, with default being 10.

Value

time_compare returns an object of class "data.frame". The data-frame consists of the following columns: test_name metric_name status metric_val message sha date_time

Warning

Function assumes the current directory to be the root directory of the package being tested.

Examples

## Not run: 
## Example-1

# Set the current directory to the git repository concerned.
setwd("./Path/to/repository")

# Specify the test-file path
t_path <- "Path/to/file"

# Pass the parameters and obtain the run-time details against 10 commits
library(Rperform)
time_compare(test_path = t_path, num_commits = 10)

## End(Not run)

analyticalmonk/Rperform documentation built on July 3, 2022, 2:36 a.m.