build_install_test: build, install and test

In tinytest: Lightweight and Feature Complete Unit Testing Framework

build, install and test

Description

Builds and installs the package in pkgdir under a temporary directory. Next, loads the package in a fresh R session and runs all the tests. For this function to work the following system requirements are necessary.

• R CMD build is available on your system

• Rscript is available on your system

Usage

build_install_test(
  pkgdir = "./",
  testdir = "tinytest",
  pattern = "^test.*\\.[rR]$",
  at_home = TRUE,
  verbose = getOption("tt.verbose", 2),
  color = getOption("tt.pr.color", TRUE),
  ncpu = 1,
  remove_side_effects = TRUE,
  side_effects = FALSE,
  lc_collate = getOption("tt.collate", NA),
  keep_tempdir = FALSE,
  encoding = "unknown"
)

Arguments

pkgdir	[character] Package directory
testdir	[character] Name of directory under pkgdir/inst containing test files.
pattern	[character] A regular expression that is used to find scripts in dir containing tests (by default .R or .r files starting with test).
at_home	[logical] toggle local tests.
verbose	[logical] toggle verbosity during execution
color	[logical] toggle colorize output
ncpu	[numeric] number of CPUs to use during the testing phase.
remove_side_effects	[logical] toggle remove user-defined side effects? See section on side effects.
side_effects	[logical|list] Either a logical, or a list of arguments to pass to report_side_effects.
lc_collate	[character] Locale setting used to sort the test files into the order of execution. The default NA ensures current locale is used. Set this e.g. to "C" to ensure bytewise and more platform-independent sorting (see details in run_test_dir.
keep_tempdir	[logical] keep directory where the pkg is installed and where tests are run? If TRUE, the directory is not deleted and it's location is printed.
encoding	[character] Encoding parameter passed to parse.

Value

A tinytests object.

See Also

Other test-files: exit_file(), run_test_dir(), run_test_file(), summary.tinytests(), test_package()

Examples

## Not run: 
  ## If your package source directory is "./pkg" you can run
  build_install_test("pkg")

## End(Not run)

tinytest documentation built on March 7, 2023, 7:43 p.m.