checkmate (version 1.8.1)

checkSubset: Check if an argument is a subset of a given set

Description

Check if an argument is a subset of a given set

Usage

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))

Arguments

x

[any] Object to check.

choices

[atomic] Set of possible values.

empty.ok

[logical(1)] Treat zero-length x as subset of any set choices? Default is TRUE.

.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 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.

See Also

Other set: checkChoice, checkSetEqual

Examples

testSubset(c("a", "z"), letters)
testSubset("ab", letters)
testSubset("Species", names(iris))