test.data.table {data.table} | R Documentation |
Runs a set of tests.
Description
Runs a set of tests to check data.table is working correctly.
Usage
test.data.table(script = "tests.Rraw", verbose = FALSE, pkg = ".",
silent = FALSE,
showProgress = interactive() && !silent,
memtest = Sys.getenv("TEST_DATA_TABLE_MEMTEST", 0),
memtest.id = NULL)
Arguments
script |
Run arbitrary R test script. |
verbose |
|
pkg |
Root directory name under which all package content (ex: DESCRIPTION, src/, R/, inst/ etc..) resides. Used only in dev-mode. |
silent |
Controls what happens if a test fails. Like |
showProgress |
Output 'Running test <n> ...\r' at the start of each test? |
memtest |
Measure and report memory usage of tests (1:gc before ps, 2:gc after ps) rather than time taken (0) by default. Intended for and tested on Linux. See PR #5515 for more details. |
memtest.id |
An id for which to print memory usage for every sub id. May be a range of ids. |
Details
Runs a series of tests. These can be used to see features and examples of usage, too. Running test.data.table will tell you the full location of the test file(s) to open.
Setting silent=TRUE
sets showProgress=FALSE
too, via the default of showProgress
.
Value
If all tests were successful, TRUE
is returned. Otherwise, see the silent
argument above. silent=TRUE
is intended for use at the start of production scripts; e.g. stopifnot(test.data.table(silent=TRUE))
to check data.table
is passing its own tests before proceeding.
See Also
Examples
## Not run:
test.data.table()
## End(Not run)