checkmate (version 1.6.1)

checkSubset: Check if object is a subset of a given set

Description

Check if object is a subset of a given set

Usage

checkSubset(x, choices, empty.ok = TRUE)
assertSubset(x, choices, empty.ok = TRUE, .var.name)
testSubset(x, choices, empty.ok = TRUE)
expect_subset(x, choices, empty.ok = TRUE, info = NULL, label = NULL)

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 for x. Defaults to a heuristic to determine the name using deparse and substitute.

info

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

label

[character(1)] Same as .var.name, but passed down to expect_that.

Value

• Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertSubset throws an error message, testSubset returns FALSE, checkSubset returns a string with the error message. The function expect_subset will return an expectation.

See Also

Other set: assertChoice, checkChoice, expect_choice, testChoice; assertSetEqual, checkSetEqual, expect_set_equal, testSetEqual

Examples

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