checkChoice: Check if an object is an element of a given set

Description Usage Arguments Value Note See Also Examples

View source: R/checkChoice.R

Description

Check if an object is an element of a given set

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
checkChoice(x, choices, null.ok = FALSE)

check_choice(x, choices, null.ok = FALSE)

assertChoice(x, choices, null.ok = FALSE, .var.name = vname(x),
  add = NULL)

assert_choice(x, choices, null.ok = FALSE, .var.name = vname(x),
  add = NULL)

testChoice(x, choices, null.ok = FALSE)

test_choice(x, choices, null.ok = FALSE)

expect_choice(x, choices, null.ok = FALSE, info = NULL, label = vname(x))

Arguments

x

[any]
Object to check.

choices

[atomic]
Set of possible values.

null.ok

[logical(1)]
If set to TRUE, x may also be NULL. In this case only a type check of x is performed, all additional checks are disabled.

.var.name

[character(1)]
Name of the checked object to print in assertions. Defaults to the heuristic implemented in vname.

add

[AssertCollection]
Collection to store assertion messages. See AssertCollection.

info

[character(1)]
Extra information to be included in the message for the testthat reporter. See expect_that.

label

[character(1)]
Name of the checked object to print in messages. Defaults to the heuristic implemented in vname.

Value

Depending on the function prefix: If the check is successful, the functions assertChoice/assert_choice return x invisibly, whereas checkChoice/check_choice and testChoice/test_choice return TRUE. If the check is not successful, assertChoice/assert_choice throws an error message, testChoice/test_choice returns FALSE, and checkChoice returns a string with the error message. The function expect_choice always returns an expectation.

Note

The object x must be of the same type as the set w.r.t. typeof. Integers and doubles are both treated as numeric.

See Also

Other set: checkSetEqual, checkSubset

Examples

1
2
3
4
5
6
testChoice("x", letters)

# x is not converted before the comparison (except for numerics)
testChoice(factor("a"), "a")
testChoice(1, "1")
testChoice(1, as.integer(1))

checkmate documentation built on July 4, 2017, 9:46 a.m.