are.parrice.valid: Are the Distribution Parameters Consistent with the Rice...

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

Are the Distribution Parameters Consistent with the Rice Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfrice, pdfrice, quarice, and lmomrice) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.parrice.valid function.

Usage

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

Arguments

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

Note

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

Author(s)

W.H. Asquith

References

Asquith, W.H., 2011, Distributional analysis with L-moment statistics using the R environment for statistical computing: Createspace Independent Publishing Platform, ISBN 978–146350841–8.

See Also

is.rice, parrice

Examples

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

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