distr6 (version 1.5.2)

testParameterSetCollection: assert/check/test/ParameterSetCollection

Description

Validation checks to test if a given object is a ParameterSetCollection.

Usage

testParameterSetCollection(
  object,
  errormsg = paste(object, "is not an R6 ParameterSetCollection object")
)
checkParameterSetCollection(
  object,
  errormsg = paste(object, "is not an R6 ParameterSetCollection object")
)
assertParameterSetCollection(
  object,
  errormsg = paste(object, "is not an R6 ParameterSetCollection object")
)

Arguments

object

object to test

errormsg

custom error message to return if assert/check fails

Value

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

Examples

# NOT RUN {
# FALSE
testParameterSetCollection(5)
# TRUE
testParameterSetCollection(ParameterSetCollection$new(Binom = Binomial$new()$parameters()))
# }