testUnivariate: assert/check/test/Univariate

In distr6: The Complete R6 Probability Distributions Interface

assert/check/test/Univariate

Description

Validation checks to test if Distribution is univariate.

Usage

testUnivariate(
  object,
  errormsg = paste(object$short_name, "is not univariate")
)

checkUnivariate(
  object,
  errormsg = paste(object$short_name, "is not univariate")
)

assertUnivariate(
  object,
  errormsg = paste(object$short_name, "is not univariate")
)

Arguments

object	Distribution
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

testUnivariate(Binomial$new()) # TRUE

distr6 documentation built on March 28, 2022, 1:05 a.m.