are.parln3.valid {lmomco}R Documentation

Are the Distribution Parameters Consistent with the 3-Parameter Log-Normal Distribution

Description

The distribution parameter object returned by functions of this package such as by pargum are consistent with the corresponding distribution, otherwise a list would not have been returned. However, other functions (cdfln3, qualn3, and lmomln3 require consistent parameters to return the cumulative probability (nonexceedance), quantile, and L-moments of the distribution, respectively. These functions internally use the are.parln3.valid function.

Usage

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

Arguments

para A distribution parameter list returned by parln3.
nowarn A logical switch on warning surpression. 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 ln3 consistent.
FALSE If the parameters are not ln3 consistent.

Note

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

Author(s)

W.H. Asquith

References

NEED

See Also

is.ln3

Examples

para <- parln3(lmom.ub(c(123,34,4,654,37,78)))
if(are.parln3.valid(para)) Q <- qualn3(0.5,para)

[Package lmomco version 0.97.4 Index]