are.pargpa.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 Generalized Pareto Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfgpa, pdfgpa, quagpa, and lmomgpa) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.pargpa.valid function.

Usage

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

Arguments

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

Note

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

Author(s)

W.H. Asquith

References

Hosking, J.R.M., 1996, FORTRAN routines for use with the method of L-moments: Version 3, IBM Research Report RC20525, T.J. Watson Research Center, Yorktown Heights, New York.

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

See Also

is.gpa, pargpa

Examples

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

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