checkmate (version 2.3.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, fmatch = FALSE)
check_subset(x, choices, empty.ok = TRUE, fmatch = FALSE)
assertSubset(
  x,
  choices,
  empty.ok = TRUE,
  fmatch = FALSE,
  .var.name = vname(x),
  add = NULL
)
assert_subset(
  x,
  choices,
  empty.ok = TRUE,
  fmatch = FALSE,
  .var.name = vname(x),
  add = NULL
)
testSubset(x, choices, empty.ok = TRUE, fmatch = FALSE)
test_subset(x, choices, empty.ok = TRUE, fmatch = FALSE)
expect_subset(
  x,
  choices,
  empty.ok = TRUE,
  fmatch = FALSE,
  info = NULL,
  label = vname(x)
)

Value

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/check_subset

return a string with the error message. The function expect_subset always returns an

expectation.

Arguments

x

[any]
Object to check.

choices

[atomic]
Set of possible values. May be empty.

empty.ok

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

fmatch

[logical(1)]
Use the set operations implemented in fmatch in package fastmatch. If fastmatch is not installed, this silently falls back to match. fmatch modifies y by reference: A hash table is added as attribute which is used in subsequent calls.

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

See Also

Other set: checkChoice(), checkDisjunct(), checkPermutation(), checkSetEqual()

Examples

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

# x is not converted before the comparison (except for numerics)
testSubset(factor("a"), "a")
testSubset(1, "1")
testSubset(1, as.integer(1))