testMultivariate: assert/check/test/Multivariate

In distr6: The Complete R6 Probability Distributions Interface

assert/check/test/Multivariate

Description

Validation checks to test if Distribution is multivariate.

Usage

testMultivariate(
  object,
  errormsg = paste(object$short_name, "is not multivariate")
)

checkMultivariate(
  object,
  errormsg = paste(object$short_name, "is not multivariate")
)

assertMultivariate(
  object,
  errormsg = paste(object$short_name, "is not multivariate")
)

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

testMultivariate(Binomial$new()) # FALSE

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