Learn R Programming

lmomRFA (version 3.8)

lmomRFA-package: The lmomRFA package

Description

R functions for regional frequency analysis using \(L\)-moments.

Arguments

Author

J. R. M. Hosking jrmhosking@gmail.com

Details

This package implements methods described in the book “Regional frequency analysis: an approach based on \(L\)-moments” by J. R. M. Hosking and J. R. Wallis. It is a supplement to the lmom package, which implements \(L\)-moment methods for more general statistical applications.

The following functions are contained in this package.

cluagg performs agglomerative hierarchical clustering.

cluinf provides information about cluster membership in a hierarchical clustering.

clukm performs cluster analysis via the K-means algorithm.

as.regdata creates an object of class "regdata", which contains a “regional data set” consisting of summary statistics for different data samples, one of the main building blocks of regional frequency analysis.

regsamlmu computes the sample \(L\)-moments of multiple data sets.

regavlmom and reglmr both compute, with slightly different interfaces, a regional weighted average of sample \(L\)-moments from multiple sites. Function regavlmom is recommended for general use; reglmr is deprecated.

regtst computes discordancy, heterogeneity and goodness-of-fit measures for regional frequency analysis. These statistics are as described in Hosking and Wallis (1997, chaps. 3-5).

regfit fits a frequency distribution to a regional data set, giving a “regional frequency distribution”.

regqfunc and siteqfunc return the regional growth curve and the quantile functions for individual sites, respectively, from a regional frequency distribution fitted by regfit.

regquant and sitequant directly compute quantiles of the regional growth curve and of distributions for individual sites, respectively, from a regional frequency distribution fitted by regfit.

regsimh runs Monte Carlo simulations to estimate the distribution of heterogeneity and goodness-of-fit measures for an artificial region.

regsimq runs Monte Carlo simulations to estimate the variability of quantile estimates from a regional frequency distribution.

regquantbounds and sitequantbounds compute error bounds for the regional growth curve and for quantiles at individual sites, respectively, from a regional frequency distribution fitted by regfit.

Functions cluagg, cluinf, clukm, reglmr, and regtst are analogous to Fortran routines from the LMOMENTS package, version 3.04, available from StatLib at https://lib.stat.cmu.edu/general/lmoments. In addition, functions regsimh and regsimq provide similar functionality to PROGRAM XSIM in the LMOMENTS Fortran package.

References

Hosking, J. R. M., and Wallis, J. R. (1997). Regional frequency analysis: an approach based on \(L\)-moments. Cambridge University Press.