checkSubset {checkmate} | R Documentation |
Check if an argument is a subset of a given set
checkSubset(x, choices, empty.ok = TRUE) check_subset(x, choices, empty.ok = TRUE) assertSubset(x, choices, empty.ok = TRUE, .var.name = vname(x), add = NULL) assert_subset(x, choices, empty.ok = TRUE, .var.name = vname(x), add = NULL) testSubset(x, choices, empty.ok = TRUE) test_subset(x, choices, empty.ok = TRUE) expect_subset(x, choices, empty.ok = TRUE, info = NULL, label = vname(x))
x |
[any] |
choices |
[ |
empty.ok |
[ |
.var.name |
[ |
add |
[ |
info |
[character(1)] |
label |
[ |
Depending on the function prefix:
If the check is successful, the functions
assertSubset
/assert_subset
return
x
invisibly, whereas
checkSubset
/check_subset
and
testSubset
/test_subset
return
TRUE
.
If the check is not successful,
assertSubset
/assert_subset
throws an error message,
testSubset
/test_subset
returns FALSE
,
and checkSubset
returns a string with the error message.
The function expect_subset
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: checkChoice
,
checkSetEqual
testSubset(c("a", "z"), letters) testSubset("ab", letters) testSubset("Species", names(iris)) # x is converted before the comparison if necessary # note that this is subject to change in a future version testSubset(factor("a"), "a") testSubset(1, "1") testSubset(1, as.integer(1))