# Unit Testing for R

## Documentation for package ‘testthat’ version 2.0.0

- DESCRIPTION file.
- User guides, package vignettes and other documentation.

## Help Pages

auto_test | Watches code and tests for changes, rerunning tests as appropriate.
auto_test_package | Watches a package for changes, rerunning tests as appropriate.
CheckReporter | Check reporter: 13 line summary of problems
comparison-expectations | Expectation: is returned value less or greater than specified value?
context | Describe the context of a set of tests.
DebugReporter | Test reporter: start recovery.
describe | describe: a BDD testing language
equality-expectations | Expectation: is the object equal to a value?
expect | The building block of all 'expect_' functions
expect_condition | Expectation: does code produce output/message/warning/error?
expect_cpp_tests_pass | Test Compiled Code in a Package
expect_equal | Expectation: is the object equal to a value?
expect_equal_to_reference | Expectations: is the output or the value equal to a known good value?
expect_equivalent | Expectation: is the object equal to a value?
expect_error | Expectation: does code produce output/message/warning/error?
expect_false | Expectation: is the object true/false?
expect_gt | Expectation: is returned value less or greater than specified value?
expect_gte | Expectation: is returned value less or greater than specified value?
expect_identical | Expectation: is the object equal to a value?
expect_is | Expectation: does the object inherit from a S3 or S4 class, or a base type?
expect_known_hash | Expectations: is the output or the value equal to a known good value?
expect_known_output | Expectations: is the output or the value equal to a known good value?
expect_known_value | Expectations: is the output or the value equal to a known good value?
expect_length | Expectation: does a vector have the specified length?
expect_less_than | Expectation: is returned value less or greater than specified value?
expect_lt | Expectation: is returned value less or greater than specified value?
expect_lte | Expectation: is returned value less or greater than specified value?
expect_match | Expectation: does string match a regular expression?
expect_message | Expectation: does code produce output/message/warning/error?
expect_more_than | Expectation: is returned value less or greater than specified value?
expect_named | Expectation: does object have names?
expect_null | Expectation: does the object inherit from a S3 or S4 class, or a base type?
expect_output | Expectation: does code produce output/message/warning/error?
expect_output_file | Expectations: is the output or the value equal to a known good value?
expect_reference | Expectation: is the object equal to a value?
expect_s3_class | Expectation: does the object inherit from a S3 or S4 class, or a base type?
expect_s4_class | Expectation: does the object inherit from a S3 or S4 class, or a base type?
expect_setequal | Expectation: is the object equal to a value?
expect_silent | Expectation: does code produce output/message/warning/error?
expect_true | Expectation: is the object true/false?
expect_type | Expectation: does the object inherit from a S3 or S4 class, or a base type?
expect_warning | Expectation: does code produce output/message/warning/error?
fail | Default expectations that alway succeed or fail.
FailReporter | Test reporter: fail at end.
inheritance-expectations | Expectation: does the object inherit from a S3 or S4 class, or a base type?
is_testing | Run all tests in directory or package
JunitReporter | Test reporter: summary of errors in jUnit XML format.
ListReporter | List reporter: gather all test results along with elapsed time and file information.
LocationReporter | Test reporter: location
logical-expectations | Expectation: is the object true/false?
MinimalReporter | Test reporter: minimal.
MultiReporter | Multi reporter: combine several reporters in one.
output-expectations | Expectation: does code produce output/message/warning/error?
ProgressReporter | Test reporter: interactive progress bar of errors.
RstudioReporter | Test reporter: RStudio
setup | Run code on setup/teardown
SilentReporter | Test reporter: gather all errors silently.
skip | Skip a test.
skip_if | Skip a test.
skip_if_not | Skip a test.
skip_if_not_installed | Skip a test.
skip_if_translated | Skip a test.
skip_on_appveyor | Skip a test.
skip_on_bioc | Skip a test.
skip_on_cran | Skip a test.
skip_on_os | Skip a test.
skip_on_travis | Skip a test.
StopReporter | Test reporter: stop on error.
succeed | Default expectations that alway succeed or fail.
SummaryReporter | Test reporter: summary of errors.
TapReporter | Test reporter: TAP format.
TeamcityReporter | Test reporter: Teamcity format.
teardown | Run code on setup/teardown
test_check | Run all tests in directory or package
test_dir | Run all tests in directory or package
test_example | Test package examples
test_examples | Test package examples
test_file | Run all tests in specified file.
test_package | Run all tests in directory or package
test_path | Locate file in testing directory.
test_rd | Test package examples
test_that | Create a test.
use_catch | Use Catch for C++ Unit Testing