| testPackage {BiocGenerics} | R Documentation |
testPackage helps developers implement unit tests using the
RUnit testing conventions.
testPackage(pkgname=NULL, subdir="unitTests", pattern="^test_.*\\.R$",
path=getwd())
pkgname |
The name of the package whose installed unit tests are to be run. A
missing or NULL value implies that the |
subdir |
A character(1) vector providing the subdirectory in which unit tests
are located. The directory is searched first in the (installed or
source) package root, or in a subdirectory |
pattern |
A character(1) regular expression describing the file names to be evaluated; typically used to restrict tests to a subset of all test files. |
path |
A character(1) directory path indicating, when |
This function is not exported from the package namespace, and must be
invoked using triple colons, BiocGenerics:::testPackage(); it
is provided primarily for the convenience of developers.
When invoked with missing or NULL pkgname argument, the
function assumes that it has been invoked from within the package
source tree (or that the source tree is located above path),
and finds unit tests in subdir="unitTests" in either the base
or inst/ directories at the root of the package source
tree. This mode is useful when developing unit tests, since the
package does not have to be re-installed to run an updated test.
When invoked with pkgname set to the name of an installed
package, unit tests are searched for in the installed package
directory.
The function returns the result of RUnit::runTestSuite invoked
on the unit tests specified in the function call.
http://bioconductor.org/developers/how-to/unitTesting-guidelines/
## Run unit tests found in the library location where
## BiocGenerics is installed
BiocGenerics:::testPackage("BiocGenerics")
## Not run: ## Run unit tests for the package whose source tree implied
## by getwd()
BiocGenerics:::testPackage()
## End(Not run)