Check if an argument is a subset of a given set

Share:

Description

Check if an argument is a subset of a given set

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
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 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 returns a string with the error message. The function expect_subset always returns an expectation.

Note

The object x must be of the same type as the set w.r.t. typeof. Integers and doubles are both treated as numeric.

See Also

Other set: checkChoice, checkSetEqual

Examples

1
2
3
4
5
6
7
8
9
testSubset(c("a", "z"), letters)
testSubset("ab", letters)
testSubset("Species", names(iris))

# x is converted before the comparison if necessary
# note that this is subject to change in a future version
testSubset(factor("a"), "a")
testSubset(1, "1")
testSubset(1, as.integer(1))

Want to suggest features or report bugs for rdrr.io? Use the GitHub issue tracker.