expect_equal: Express expectations

Description

Express expectations

Usage

expect_equal(
  current,
  target,
  tolerance = sqrt(.Machine$double.eps),
  info = NA_character_,
  ...
)
expect_identical(current, target, info = NA_character_)
expect_equivalent(
  current,
  target,
  tolerance = sqrt(.Machine$double.eps),
  info = NA_character_,
  ...
)
expect_true(current, info = NA_character_)
expect_false(current, info = NA_character_)
expect_silent(current, quiet = TRUE, info = NA_character_)
expect_null(current, info = NA_character_)
expect_inherits(current, class, info = NA_character_)
expect_error(
  current,
  pattern = ".*",
  class = "error",
  info = NA_character_,
  ...
)
expect_warning(
  current,
  pattern = ".*",
  class = "warning",
  info = NA_character_,
  strict = FALSE,
  ...
)
expect_message(
  current,
  pattern = ".*",
  class = "message",
  info = NA_character_,
  strict = FALSE,
  ...
)
expect_stdout(current, pattern = ".*", info = NA_character_, ...)

Value

A tinytest object. A tinytest object is a logical with attributes holding information about the test that was run

Arguments

current: [R object or expression] Outcome or expression under scrutiny.
target: [R object or expression] Expected outcome
tolerance: [numeric] Test equality to machine rounding. Passed to all.equal (tolerance)
info: [character] scalar. Optional user-defined message. Must be a single character string. Multiline comments may be separated by "\n".
...: passed on to grepl (useful for e.g. fixed=TRUE).
quiet: [logical] suppress output printed by the current expression (see examples)
class: [character] For condition signals (error, warning, message) the class from which the condition should inherit.
pattern: [character] A regular expression to match the message.
strict: [logical] scalar. If set to TRUE, any exception worse than the wanted exception will cause the test to fail.

More information and examples

An overview of tinytest can be found in vignette("using_tinytest").
Examples of how tinytest is used in practice can be found in vignette("tinytest_examples")

Details

expect_equivalent calls expect_equal with the extra arguments check.attributes=FALSE and use.names=FALSE

expect_silent fails when an error or warning is thrown.

expect_inherits fails when inherits(current,class) returns FALSE

expect_stdout Expects that output is written to stdout, for example using cat or print. Use pattern to specify a regular expression matching the output.

Examples

Run this code

expect_equal(1 + 1, 2)       # TRUE
expect_equal(1 - 1, 2)       # FALSE
expect_equivalent(2, c(x=2)) # TRUE
expect_equal(2, c(x=2))      # FALSE


expect_silent(1+1)           # TRUE
expect_silent(1+"a")         # FALSE
expect_silent(print("hihi")) # TRUE, nothing goes to screen
expect_silent(print("hihi"), quiet=FALSE) # TRUE, and printed

Run the code above in your browser using DataLab

Last chance! 50% off unlimited learning