are.parpdq3.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 Polynomial Density-Quantile#

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfpdq3, pdfpdq3, quapdq3, and lmompdq3) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.parpdq3.valid function.

Usage

are.parpdq3.valid(para, nowarn=FALSE)

Arguments

para	A distribution parameter list returned by parpdq3 or vec2par.
nowarn	A logical switch on warning suppression. If TRUE then options(warn=-1) is made and restored on return. This switch is to permit calls in which warnings are not desired as the user knows how to handle the returned value—say in an optimization algorithm.

Value

TRUE	If the parameters are pdq3 consistent.
FALSE	If the parameters are not pdq3 consistent.

Note

This function calls is.pdq3 to verify consistency between the distribution parameter object and the intent of the user.

Author(s)

W.H. Asquith

See Also

is.pdq3, parpdq3

Examples

para <- parpdq3(lmoms(c(46, 70, 59, 36, 71, 48, 46, 63, 35, 52)))
if(are.parpdq3.valid(para)) Q <- quapdq3(0.5, para)

wasquith/lmomco documentation built on Nov. 13, 2024, 4:53 p.m.