are.parkap.valid: Are the Distribution Parameters Consistent with the Kappa...

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

Are the Distribution Parameters Consistent with the Kappa Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfkap, pdfkap, quakap, and lmomkap) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.parkap.valid function.

Usage

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

Arguments

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

Note

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

Author(s)

W.H. Asquith

References

Hosking, J.R.M., 1994, The four-parameter kappa distribution: IBM Journal of Reserach and Development, v. 38, no. 3, pp. 251–258.

Hosking, J.R.M., and Wallis, J.R., 1997, Regional frequency analysis—An approach based on L-moments: Cambridge University Press.

See Also

is.kap, parkap

Examples

para <- parkap(lmoms(c(123,34,4,654,37,78)))
if(are.parkap.valid(para)) Q <- quakap(0.5,para)

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