tinytest (version 1.1.0)

build_install_test: 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",
  at_home = TRUE, verbose = getOption("tt.verbose", 2), ncpu = 1,
  remove_side_effects = TRUE, side_effects = FALSE,
  keep_tempdir = FALSE)

Arguments

pkgdir

[character] Package directory

testdir

[character] Name of directory under pkgdir/inst containing test files.

at_home

[logical] toggle local tests.

verbose

[logical] toggle verbosity during execution

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.

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.

Value

A tinytests object.

See Also

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

Examples

Run this code
# NOT RUN {
  ## If your package source directory is "./pkg" you can run
  build_install_test("pkg")
# }

Run the code above in your browser using DataLab