checkSubset {checkmate}R Documentation

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)

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.

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 and checkSubset returns a string with the error message.

See Also

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

Examples

testSubset(c("a", "z"), letters)
testSubset("ab", letters)
testSubset("Species", names(iris))
[Package checkmate version 1.6.0 Index]