compare_PR: Analyze PR's impact on performance without having to merge.

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

Analyze PR's impact on performance without having to merge.

Description

The function must be called from a directory containing only a single git repository checked out to the branch which is meant to be tested against the master branch of the repository's remote repo. This function is designed keeping in mind the PR testing methodlogy of Travis-CI. Given a test-file path and the required metric, it returns the metric details of the file against the first commit till the latest common commit for the git repo, and against the latest commit for master branch of the repo's remote. It also returns information regarding the latest common commit for the two directories.

Usage

compare_PR(test_path, metric = "time")

Arguments

test_path	File-path, relative to the git repo, for the test file to be tested.
metric	The metric (runtime or memory) for which the file is to be tested.

Value

compare_brancht returns an object of class "list" containing two members.

The first member is a data-frame and consists of the following columns: test_name metric_name status metric_val message sha date_time directory

The second member is a data-frame and consists of the following columns: common_datetime common_message cnum_b1 cnum_b2

Warning

Function assumes the current directory to be the parent directory of the the repository being tested.

Examples

## Not run: 
# Set the current directory to the parent directory of the concerned repository.
setwd("./Path/to/parent/directory")

# Set the file-path
t_path <- "Path/to/file"

# Load the library and pass the parameters to the function
library(Rperform)
compare_PR(t_path, metric = "time")

## End(Not run)

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