are.parray.valid: Are the Distribution Parameters Consistent with the Rayleigh...

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

Are the Distribution Parameters Consistent with the Rayleigh Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfray, pdfray, quaray, and lmomray) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.parray.valid function.

Usage

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

Arguments

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

Note

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

Author(s)

W.H. Asquith

References

Hosking, J.R.M., 1986, The theory of probability weighted moments: Research Report RC12210, IBM Research Division, Yorkton Heights, N.Y.

See Also

is.ray, parray

Examples

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

lmomco documentation built on May 29, 2024, 10:06 a.m.