mem_compare: Test-file's memory statistics for multiple commits.

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

Test-file's memory statistics for multiple commits.

Description

Given a test-file's path, checks its memory metrics against the number of commits specified by the parameter num_commits with default being 10. Memory metrics returned are the memory leaked and maximum meory utilized during its execution.

Usage

mem_compare(test_path, num_commits = 10)

Arguments

test_path	File-path for the test file which is to be checked.
num_commits	number of commits against all of which the memory stats are to be checked starting from the most recent one.

Value

time_commit 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
library(Rperform)
mem_compare(t_path, 10)

## End(Not run)

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