RunExamples: RunExamples

In runExamplesWrapper: Wrapper for 'run_examples()'

RunExamples

Description

driver to automate run_examples() and retrieve the test results for each example

Usage

RunExamples(
  pack,
  run_donttest = TRUE,
  run_dontrun = TRUE,
  out = sprintf("%s/%s", tempdir(), "runExamplesOut.txt"),
  verbose = FALSE
)

Arguments

pack	character string containing the path name of the package directory
run_donttest	parameter to be passed to run_examples()
run_dontrun	parameter to be passed to run_examples()
out	character string containing the path name of the run_examples() results output file
verbose	Boolean if TRUE generate some diagnostic information

Value

returns a character vector specifying each function example as either "GOOD", "BAD", or "MIA"

Examples

## Not run: 
# replace dir and pack with your own versions!!
# run this example within the RStudio Console for the package 'pack'
dir1<-"~/personal/hearts/hearts_card_game_bayesian_inference/packages/"
dir2<-"inference_packages/inference_packages/"
dir<-sprintf("%s/%s",dir1,dir2)
pack<-sprintf("%s/%s",dir,"cardUtils")
v<-RunExamples(pack,verbose=FALSE)

## End(Not run)

runExamplesWrapper documentation built on April 12, 2025, 2:01 a.m.