testSubset: assert/check/test/Subset

View source: R/assertions.R

testSubsetR Documentation

assert/check/test/Subset

Description

Validation checks to test if given sets are subsets of a set.

Usage

testSubset(
  object,
  sets,
  proper = FALSE,
  errormsg = "sets are not subsets of the object"
)

checkSubset(
  object,
  sets,
  proper = FALSE,
  errormsg = "sets are not subsets of the object"
)

assertSubset(
  object,
  sets,
  proper = FALSE,
  errormsg = "sets are not subsets of the object"
)

Arguments

object

object to test

sets

sets to check

proper

logical. If TRUE tests for proper subsets.

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

testSubset(Set$new(1,2,3), Set$new(1,2))
testSubset(Set$new(1,2,3), Set$new(3,4))

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