testContains: assert/check/test/Contains

Description Usage Arguments Value Examples

View source: R/assertions.R

Description

Validation checks to test if given elements are contained in a set.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
testContains(
  object,
  elements,
  errormsg = "elements are not contained in the set"
)

checkContains(
  object,
  elements,
  errormsg = "elements are not contained in the set"
)

assertContains(
  object,
  elements,
  errormsg = "elements are not contained in the set"
)

Arguments

object

object to test

elements

elements to check

errormsg

error message to overwrite default if check fails

Value

If check passes then assert returns object invisibly and test/check return TRUE. If check fails, assert stops code with error, check returns an error message as string, and test returns FALSE.

Examples

1
2
testContains(Set$new(1,2,3), c(1,2))
testContains(Set$new(1,2,3), c(3,4))

set6 documentation built on Oct. 18, 2021, 5:06 p.m.