testContains: assert/check/test/Contains

View source: R/assertions.R

testContainsR Documentation

assert/check/test/Contains

Description

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

Usage

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

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

xoopR/set6 documentation built on Sept. 2, 2023, 4:45 a.m.