distr6 (version 1.5.6)

testParameterSet: assert/check/test/ParameterSet

Description

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

Usage

testParameterSet(
  object,
  errormsg = paste(object, "is not an R6 ParameterSet object")
)
checkParameterSet(
  object,
  errormsg = paste(object, "is not an R6 ParameterSet object")
)
assertParameterSet(
  object,
  errormsg = paste(object, "is not an R6 ParameterSet 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 {
testParameterSet(5) # FALSE
testParameterSet(Binomial$new()$parameters()) # TRUE
# }