test_package {testthat} | R Documentation |
Run all tests in a package
Description
-
test_local()
tests a local source package. -
test_package()
tests an installed package. -
test_check()
checks a package duringR CMD check
.
See vignette("special-files")
to learn about the various files that
testthat works with.
Usage
test_package(package, reporter = check_reporter(), ...)
test_check(package, reporter = check_reporter(), ...)
test_local(path = ".", reporter = NULL, ..., load_package = "source")
Arguments
package |
If these tests belong to a package, the name of the package. |
reporter |
Reporter to use to summarise output. Can be supplied
as a string (e.g. "summary") or as an R6 object
(e.g. See Reporter for more details and a list of built-in reporters. |
... |
Additional arguments passed to |
path |
Path to directory containing tests. |
load_package |
Strategy to use for load package code:
|
Value
A list (invisibly) containing data about the test results.
R CMD check
To run testthat automatically from R CMD check
, make sure you have
a tests/testthat.R
that contains:
library(testthat) library(yourpackage) test_check("yourpackage")
Environments
Each test is run in a clean environment to keep tests as isolated as possible. For package tests, that environment inherits from the package's namespace environment, so that tests can access internal functions and objects.