Rperform (version 0.0.0.9000)

compare_branchm: Memory metrics across branches.

Description

Given a test-file and two branches, returns the memory metrics of the file against the first commit till the latest common commit in branch1, and against the latest commit in branch2. Memory metrics returned are the memory leaked and maximum memory utilized during its execution.

Usage

compare_branchm(test_path, branch1, branch2 = "master")

Arguments

test_path

File-path for the test file to be tested.

branch1

Branch against whose commits the test file is to be tested.

branch2

Branch into which branch1 is supposedly to be merged.

Value

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

Warning

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

Examples

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

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

# Load the library and pass the parameters to the function
library(Rperform)
compare_branchm(test_path = t_path, branch1 = "helper", branch2 = "master")
# }
# NOT RUN {
# }