are.pargum.valid {lmomco} | R Documentation |
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 (cdfgum
, quagum
, and
lmomgum
require consistent parameters to return the cumulative
probability (nonexceedance), quantile, and L-moments of the distribution,
respectively. These functions internally use the are.pargum.valid
function. The FORTRAN source code of Hosking provides the basis
for the function.
are.pargum.valid(para,nowarn=FALSE)
para |
A distribution parameter list returned by pargum . |
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. |
TRUE |
If the parameters are gum consistent. |
FALSE |
If the parameters are not gum consistent. |
This function calls is.gum
to verify consistency between
the distribution parameter object and the intent of the user.
W.H. Asquith
Hosking, J.R.M., 1996, FORTRAN routines for use with the method of L-moments: Version 3, IBM Research Report RC20525, T.J. Watson Research Center, Yorktown Heights, New York.
Hosking, J.R.M. and Wallis, J.R., 1997, Regional frequency analysis—An approach based on L-moments: Cambridge University Press.
para <- pargum(lmom.ub(c(123,34,4,654,37,78))) if(are.pargum.valid(para)) Q <- quagum(0.5,para)