distr6 (version 1.5.6)

testDistribution: assert/check/test/Distribution

Description

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

Usage

testDistribution(
  object,
  errormsg = paste(object, "is not an R6 Distribution object")
)
checkDistribution(
  object,
  errormsg = paste(object, "is not an R6 Distribution object")
)
assertDistribution(
  object,
  errormsg = paste(object, "is not an R6 Distribution 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 {
testDistribution(5) # FALSE
testDistribution(Binomial$new()) # TRUE
# }