H2 {UKFE}R Documentation

Heterogeneity measure (H2) for pooling groups.

Description

Quantifies the heterogeneity of a pooled group

Usage

H2(x, H1 = FALSE)

Arguments

x

pooling group derived from the Pool() function

H1

logical with a default of FALSE. If TRUE, the function applies the 'H1' version of the test (see Hosking & Wallis 1997 reference). If FALSE, the default H2 version is applied.

Details

The H2 measure was developed by Hosking & Wallis and can be found in their book 'Regional Frequency Analysis: an approach based on LMoments (1997). It was also adopted for use by the Flood Estimation Handbook (1999) and is described in volume 3.

Value

A vector of two characters; the first representing the H2 score and the second stating a qualitative measure of heterogeneity.

Author(s)

Anthony Hammond

Examples

#Get CDs, form a pooling group and calculate H2
CDs.203018 <- GetCDs(203018)
Pool.203018 <- Pool(CDs.203018)
H2(Pool.203018)

[Package UKFE version 0.3.5 Index]