testPlatykurtic: assert/check/test/Platykurtic

In alan-turing-institute/distr6: The Complete R6 Probability Distributions Interface

assert/check/test/Platykurtic

Description

Validation checks to test if Distribution is platykurtic.

Usage

testPlatykurtic(
  object,
  errormsg = paste(object$short_name, "is not platykurtic")
)

checkPlatykurtic(
  object,
  errormsg = paste(object$short_name, "is not platykurtic")
)

assertPlatykurtic(
  object,
  errormsg = paste(object$short_name, "is not platykurtic")
)

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

testPlatykurtic(Binomial$new())

alan-turing-institute/distr6 documentation built on July 8, 2024, 4:51 p.m.