checkChoice {checkmate} | R Documentation |
Check if an object is an element of a given set
checkChoice(x, choices, null.ok = FALSE, fmatch = FALSE) check_choice(x, choices, null.ok = FALSE, fmatch = FALSE) assertChoice(x, choices, null.ok = FALSE, fmatch = FALSE, .var.name = vname(x), add = NULL) assert_choice(x, choices, null.ok = FALSE, fmatch = FALSE, .var.name = vname(x), add = NULL) testChoice(x, choices, null.ok = FALSE, fmatch = FALSE) test_choice(x, choices, null.ok = FALSE, fmatch = FALSE) expect_choice(x, choices, null.ok = FALSE, fmatch = FALSE, info = NULL, label = vname(x))
x |
[any] |
choices |
[ |
null.ok |
[ |
fmatch |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
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
.
The object x
must be of the same type as the set w.r.t. typeof
.
Integers and doubles are both treated as numeric.
Other set: checkSetEqual
,
checkSubset
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))