checkmate (version 1.7.2)

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)

assertSubset(x, choices, empty.ok = TRUE, add = NULL, .var.name)

assert_subset(x, choices, empty.ok = TRUE, add = NULL, .var.name)

testSubset(x, choices, empty.ok = TRUE)

test_subset(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.
add
[AssertCollection] Collection to store assertions. See AssertCollection.
.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, 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

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

Run the code above in your browser using DataCamp Workspace