are.par.valid: Are the Distribution Parameters Consistent with the...

In wasquith/lmomco: L-Moments, Censored L-Moments, Trimmed L-Moments, L-Comoments, and Many Distributions

Are the Distribution Parameters Consistent with the Distribution

Description

This function is a dispatcher on top of the are.parCCC.valid functions, where CCC represents the distribution type: aep4, cau, emu, exp, gam, gep, gev, glo, gno, gov, gpa, gum, kap, kmu, kur, lap, ln3, nor, pe3, ray, revgum, rice, sla, smd, st3, texp, tri, wak, or wei. For lmomco functionality, are.par.valid is called only by vec2par in the process of converting a vector into a proper distribution parameter object.

Usage

are.par.valid(para, paracheck=TRUE, ...)

Arguments

para	A distribution parameter object having at least attributes type and para.
paracheck	A logical controlling whether the parameters are checked for validity and if paracheck=TRUE then effectively this whole function becomes turned off.
...	Additional arguments for the are.parCCC.valid call that is made internally.

Value

TRUE	If the parameters are consistent with the distribution specified by the type attribute of the parameter object.
FALSE	If the parameters are not consistent with the distribution specified by the type attribute of the parameter object.

Author(s)

W.H. Asquith

References

Asquith, W.H., 2011, Distributional analysis with L-moment statistics using the R environment for statistical computing: Createspace Independent Publishing Platform, ISBN 978–146350841–8.

See Also

vec2par, dist.list

Examples

vec  <- c(12, 120)           # parameters of exponential distribution
para <- vec2par(vec, "exp")  # build exponential distribution parameter
                             # object
# The following two conditionals are equivalent as are.parexp.valid()
# is called within are.par.valid().
if(   are.par.valid(para)) Q <- quaexp(0.5, para)
if(are.parexp.valid(para)) Q <- quaexp(0.5, para)

wasquith/lmomco documentation built on April 20, 2024, 7:20 p.m.