checkmate (version 1.8.1)

checkSetEqual: Check if an argument is equal to a given set

Description

Check if an argument is equal to a given set

Usage

checkSetEqual(x, y, ordered = FALSE)
check_set_equal(x, y, ordered = FALSE)
assertSetEqual(x, y, ordered = FALSE, .var.name = vname(x), add = NULL)
assert_set_equal(x, y, ordered = FALSE, .var.name = vname(x), add = NULL)
testSetEqual(x, y, ordered = FALSE)
test_set_equal(x, y, ordered = FALSE)
expect_set_equal(x, y, ordered = FALSE, info = NULL, label = vname(x))

Arguments

x

[any] Object to check.

y

[atomic] Set to compare with.

ordered

[logical(1)] Check x to have the same length and order as y, i.e. check using “==” while handling NAs nicely. Default is FALSE.

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

Examples

 testSetEqual(c("a", "b"), c("a", "b"))
 testSetEqual(1:3, 1:4)