are.parkmu.valid: Are the Distribution Parameters Consistent with the Kappa-Mu...

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

Are the Distribution Parameters Consistent with the Kappa-Mu Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (pdfkmu, cdfkmu, quakmu, and lmomkmu) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.parkmu.valid function. The documentation for pdfkmu provides the conditions for valid parameters.

Usage

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

Arguments

para	A distribution parameter list returned by parkmu 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 kmu consistent.
FALSE	If the parameters are not kmu consistent.

Note

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

Author(s)

W.H. Asquith

See Also

is.kmu, parkmu

Examples

para <- vec2par(c(0.5, 1.5), type="kmu")
if(are.parkmu.valid(para)) Q <- quakmu(0.5,para)

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