Description Usage Arguments Value Note See Also Examples

View source: R/checkSetEqual.R

Check if an argument is equal to a given set

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 | ```
checkSetEqual(x, y, ordered = FALSE, fmatch = FALSE)
check_set_equal(x, y, ordered = FALSE, fmatch = FALSE)
assertSetEqual(x, y, ordered = FALSE, fmatch = FALSE,
.var.name = vname(x), add = NULL)
assert_set_equal(x, y, ordered = FALSE, fmatch = FALSE,
.var.name = vname(x), add = NULL)
testSetEqual(x, y, ordered = FALSE, fmatch = FALSE)
test_set_equal(x, y, ordered = FALSE, fmatch = FALSE)
expect_set_equal(x, y, ordered = FALSE, fmatch = FALSE, info = NULL,
label = vname(x))
``` |

`x` |
[any] |

`y` |
[ |

`ordered` |
[ |

`fmatch` |
[ |

`.var.name` |
[ |

`add` |
[ |

`info` |
[character(1)] |

`label` |
[ |

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`

.

The object `x`

must be of the same type as the set w.r.t. `typeof`

.
Integers and doubles are both treated as numeric.

Other set: `checkChoice`

,
`checkSubset`

1 2 3 4 5 6 7 | ```
testSetEqual(c("a", "b"), c("a", "b"))
testSetEqual(1:3, 1:4)
# x is not converted before the comparison (except for numerics)
testSetEqual(factor("a"), "a")
testSetEqual(1, "1")
testSetEqual(1, as.integer(1))
``` |

checkmate documentation built on Nov. 17, 2017, 4:19 a.m.

Embedding an R snippet on your website

Add the following code to your website.

For more information on customizing the embed code, read Embedding Snippets.