checkSetEqual {checkmate}R Documentation

Check if object is a subset of a given set

Description

Check if object is a subset of a given set

Usage

checkSetEqual(x, y, ordered = FALSE)

assertSetEqual(x, y, ordered = TRUE, .var.name)

testSetEqual(x, y, ordered = TRUE)

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 for x. Defaults to a heuristic to determine the name using deparse and substitute.

Value

Depending on the function prefix: If the check is successful, all functions return TRUE. If the check is not successful, assertSubset throws an error message, testSubset returns FALSE and checkSubset returns a string with the error message.

See Also

Other set: assertChoice, checkChoice, testChoice; assertSubset, checkSubset, testSubset

Examples

testSetEqual(c("a", "b"), c("a", "b"))
 testSetEqual(1:3, 1:4)
[Package checkmate version 1.6.0 Index]