are.parkap.valid {lmomco} | R Documentation

## Are the Distribution Parameters Consistent with the Kappa Distribution

### Description

The distribution parameter object returned by functions of this package such as by `parkap` are consistent with the corresponding distribution, otherwise a list would not have been returned. However, other functions (`cdfkap`, `quakap`, and `lmomkap` require consistent parameters to return the cumulative probability (nonexceedance), quantile, and L-moments of the distribution, respectively. These functions internally use the `are.parkap.valid` function. The FORTRAN source code of Hosking provides the basis for the function.

### Usage

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

### Arguments

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

### Note

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

### Author(s)

W.H. Asquith

### References

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.

### See Also

`is.kap`

### Examples

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

[Package lmomco version 0.92 Index]