are.parst3.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 3-Parameter Student t Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfst3, pdfst3, quast3, and lmomst3) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.parst3.valid function.

Usage

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

Arguments

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

Note

This function calls is.st3 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.st3, parst3

Examples

para <- parst3(lmoms(c(90,134,100,114,177,378)))
if(are.parst3.valid(para)) Q <- quast3(0.5,para)

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