test

0th

Percentile

Execute test_that tests in a package.

test() is a shortcut for testthat::test_dir(), it runs all of a package's tests. test_file runs test() on the active file. test_coverage() computes test coverage for your package. It is a shortcut for covr::package_coverage() and covr::report(). test_coverage_file() computes test coverage for the active file. Is a shortcut for covr::file_coverage() and covr::report().

Usage
test(pkg = ".", filter = NULL, stop_on_failure = FALSE, export_all = TRUE, ...)

test_coverage(pkg = ".", show_report = interactive(), ...)

uses_testthat(pkg = ".")

test_file(file = find_active_file(), ...)

test_coverage_file( file = find_active_file(), filter = TRUE, show_report = interactive(), export_all = TRUE, ... )

Arguments
pkg

The package to use, can be a file path to the package or a package object. See as.package() for more information.

filter

If not NULL, only tests with file names matching this regular expression will be executed. Matching be performed on the file name after it has been stripped of "test-" and ".R".

stop_on_failure

If TRUE, throw an error if any tests fail.

For historical reasons, the default value of stop_on_failure is TRUE for test_package() and test_check() but FALSE for test_dir(), so if you're calling test_dir() you may want to consider explicitly setting stop_on_failure = TRUE.

export_all

If TRUE (the default), export all objects. If FALSE, export only the objects that are listed as exports in the NAMESPACE file.

...

additional arguments passed to testthat::test_dir() and covr::package_coverage()

show_report

Show the test coverage report.

file

One or more source or test files. If a source file the corresponding test file will be run. The default is to use the active file in RStudio (if available).

Aliases
  • test
  • test_coverage
  • uses_testthat
  • test_file
  • test_coverage_file
Documentation reproduced from package devtools, version 2.3.0, License: GPL (>= 2)

Community examples

Looks like there are no examples yet.