PoolGroup: Fitting a index-flood model on a pooling groups
In martindurocher/floodStat: FloodNet Regional Frequency Analysis

Description Usage Arguments Value References Examples

Returns a pooling group model with regional parameters and common homogeneity statistics diagnostics. The function can be used for analysing annual maximum or peaks over threshold.

1	PoolGroup(x, ...)

`lmom`	Matrix of the at-site L-moments of all sites.
`intersite`	An intersite object. Alternative to pass L-moments directly.
`nrec`	Record Length of each site. If a single value is passed, it is applied to all sites.
`nk`	Size of the desired pooling groups.
`distr`	At-site distribution of each site. If a single value is passed, it is applied to all sites.
`distance`	Vector of distance with the target site. The target is included with distance zero.
`method`	Type of data used. Either annual maximums ('amax') or peaks over threshold ('pot').
`diagnostic`	Shoud the diagnostics homogeneity and Z-score be evaluated.
`diagnostic.nsim`	Number of simulations used to evaluate the diagnostics.
`pvalue`	Logical. Should the p-value of the homogeneity test be computed?
`pvalue.nrep, pvalue.nsim`	Number of repetitions and simulations used for evaluating the p-value.
`inter`	Type of intersite correlation used for simulation. For ''mat''the empirical correlation matrix is used directly. For ''avg'' the average coefficient of correlation is used.
`inter.corr`	Intersite correlation matrix of all sites.

`id`	List of the selected sites
`nrec`	Record lengths.
`distance`	Distance matrix.
`lmom`	Matrix of L-moments.
`rlmom`	Regional L-moments.
`ntot`	Number of station-year.
`distr`	Regional distribution
`para`	Parameters of the regional distribution
`method`	Type of analysis. Annual maximum ('amax') or peaks over threshold('pot')
`stat`	Homogenous criteria and Z-score for goodness-of-fit.
`pvalue`	P-values of 'stat'
`discord`	Discordance measures.
`inter`	Type of intersite correlation model used.
`inter.corr`	Intersite correlation matrix
`inter.avg`	Pairwise average of the intersite correlation.

Hosking, J. R. M., & Wallis, J. R. (1997). Regional frequency analysis: an approach based on L-moments. Cambridge Univ Pr.

Mostofi Zadeh, S., Durocher, M., Burn, D.H., Ashkar, F., 2019. Pooled flood frequency analysis: a comparison based on peaks-over-threshold and annual maximum series. Hydrological Sciences Journal 0, null. https://doi.org/10.1080/02626667.2019.1577556

isite <- Intersite(ams ~ id + year, flowAtlantic$ams,
                   distance = flowAtlantic$distance,
                   smooth = TRUE)

fit <- PoolGroup(isite, distance = 2, nk = 15)
print(fit)

## Create a L-moment ratio diagram.
plot(fit)