runExamplesWrapper (version 1.0)

RunExamples: 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
)

Value

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

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

Examples

if (FALSE) {
# 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)
}