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

Description Usage Arguments Value Note See Also Examples

Description

Check if an argument is equal to a given set

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
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 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, checkSubset

Examples

1
2
3
4
5
6
7
8
testSetEqual(c("a", "b"), c("a", "b"))
testSetEqual(1:3, 1:4)

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


Search within the checkmate package
Search all R packages, documentation and source code

Questions? Problems? Suggestions? or email at ian@mutexlabs.com.

Please suggest features or report bugs with the GitHub issue tracker.

All documentation is copyright its authors; we didn't write any of that.