R: Summary of test statistics for regional frequency analysis
summary.regtst
R Documentation
Summary of test statistics for regional frequency analysis
Description
summary method for an object of class "regtst".
Usage
## S3 method for class 'regtst'
summary(object,
prob = c(0.01, 0.02, 0.05, 0.1, 0.2, 0.5, 0.8, 0.9, 0.95, 0.98, 0.99, 0.999),
conf = 0.90, decimals = c(4, 4, 2, 3), ...)
## S3 method for class 'summary.regtst'
print(x, decimals, ...)
Arguments
object
An object of class "regtst", usually the result of a call to
regtst.
x
An object of class "summary.regtst", usually the result of a
call to summary.regtst.
prob
Nonexceedance probabilities for which quantile estimates
should be printed.
conf
Confidence level for printing parameter and quantile estimates.
These quantities will be printed only for distributions that
give an adequate fit at the specified confidence level.
decimals
Vector of length 4. The four elements specify the number of
decimal places to be used when printing L-moment ratios,
distribution parameters, test statistics,
and quantile estimates, respectively.
...
Further arguments passed to or from other methods.
Details
The printed output corresponds closely to that produced by
function REGTST in the LMOMENTS Fortran package (Hosking, 1996).
Value
summary.regtst and print.summary.regtst each return,
invisibly, an object of class "summary.regtst", which is a list
with elements as for class "regtst", plus the following elements:
conf
Confidence level — the conf argument supplied to
summary.regtst.
prob
Vector of nonexceedance probabilities — the prob argument
supplied to summary.regtst.
quant
Matrix with 6 rows and length(prob) columns, containing
quantile estimates for the five candidate distributions and the
Wakeby distribution.
decimals
Vector of length 4. Number of decimals to be used when printing
an object of class "summary.regtst" if the decimals
argument of print.summary.regtst is not specified.
Hosking, J. R. M. (1996).
Fortran routines for use with the method of L-moments, Version 3.
Research Report RC20525, IBM Research Division, Yorktown Heights, N.Y.
See Also
regtst
Examples
# An example from Hosking (1996). Compare the output with
# the file 'cascades.out' in the LMOMENTS Fortran package at
# http://lib.stat.cmu.edu/lmoments/general (results will not
# be identical, because random-number generators are different).
summary(regtst(Cascades, nsim=500))