testLeptokurtic: assert/check/test/Leptokurtic

View source: R/assertions.R

testLeptokurticR Documentation

assert/check/test/Leptokurtic

Description

Validation checks to test if Distribution is leptokurtic.

Usage

testLeptokurtic(
  object,
  errormsg = paste(object$short_name, "is not leptokurtic")
)

checkLeptokurtic(
  object,
  errormsg = paste(object$short_name, "is not leptokurtic")
)

assertLeptokurtic(
  object,
  errormsg = paste(object$short_name, "is not leptokurtic")
)

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

testLeptokurtic(Binomial$new())

RaphaelS1/distr6 documentation built on Feb. 24, 2024, 9:14 p.m.