assert/check/test/Multivariate

Source: R/assertions.R

Validation checks to test if Distribution is multivariate.

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
#> [1] FALSE