risk.assessr (version 3.0.1)

generate_traceability_matrix: Assess an R Package traceability matrix from package name and version

Description

This function use `risk.assessr::create_traceability_matrix` function with only the package name and version

Usage

generate_traceability_matrix(
  package_name,
  version = NA,
  repos = NULL,
  execute_coverage = FALSE
)

Value

The function returns package traceability_matrix If the package cannot be downloaded or installed, an error message is returned.

Arguments

package_name

A character string specifying the name of the package to assess.

version

A character string specifying the version of the package to assess. Default is `NA`, which assesses the latest version.

repos

A character string specifying the repo directly. Default is NULL, which uses the mirrors

execute_coverage

Logical (`TRUE`/`FALSE`). If `TRUE`, execute test coverage.

Examples

if (FALSE) {
r <- getOption("repos")
# save current repo options  
old <- options(repos = r)
r["CRAN"] = "http://cran.us.r-project.org"
options(repos = r)#' 

results_no_test_covr <- generate_traceability_matrix(
 "here", 
 version = "1.0.1", 
 execute_coverage = FALSE
)

results_test_covr <- generate_traceability_matrix(
 "here", 
 version = "1.0.1", 
 execute_coverage = TRUE
)

# restore user's repo options
options(old)

print(results_no_test_covr)

print(results_test_covr)
}