are.parcau.valid {lmomco} | R Documentation

## Are the Distribution Parameters Consistent with the Cauchy Distribution

### Description

The distribution parameter object returned by functions of this package such as by `vec2par` are consistent with the corresponding distribution, otherwise a list would not have been returned. However, other functions (`cdfcau` and `quacau`) require consistent parameters to return the cumulative probability (nonexceedance), quantile, and L-moments of the distribution, respectively.

### Usage

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

### Arguments

`para` | A distribution parameter list returned by `parcau` or `vec2par`.
`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.
`...` | Additional arguments for the `are.parCCC.valid` call that is made internally.

### Value

`TRUE` | If the parameters are `cau` consistent.
`FALSE` | If the parameters are not `cau` consistent.

### Note

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

### Author(s)

W.H. Asquith

### References

Elamir, E.A.H., and Seheult, A.H., 2003, Trimmed L-moments: Computational Statistics and Data Analysis, vol. 43, pp. 299–314.

Gilchrist, W.G., 2000, Statistical modeling with quantile functions: Chapman and Hall/CRC, Boca Raton, FL.

### See Also

`is.cau`

### Examples

    para <- vec2par(c(12,12),type='cau')
    if(are.parcau.valid(para)) Q <- quacau(0.5,para)

[Package lmomco version 0.92 Index]