are.pargdd.valid: Are the Distribution Parameters Consistent with the Gamma...

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

Are the Distribution Parameters Consistent with the Gamma Difference Distribution

Description

Is the distribution parameter object consistent with the corresponding distribution? The distribution functions (cdfgdd, pdfgdd, quagdd, and lmomgdd) require consistent parameters to return the cumulative probability (nonexceedance), density, quantile, and L-moments of the distribution, respectively. These functions internally use the are.pargdd.valid function.

Usage

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

Arguments

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

Note

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

Author(s)

W.H. Asquith

References

Klar, B., 2015, A note on gamma difference distributions: Journal of Statistical Computation and Simulation v. 85, no. 18, pp. 1–8, \Sexpr[results=rd]{tools:::Rd_expr_doi("10.1080/00949655.2014.996566")}.

See Also

is.gdd, pargdd

Examples

#

wasquith/lmomco documentation built on May 25, 2024, 7:18 p.m.