H2: Heterogeneity measure (H2) for pooling groups.

Description Usage Arguments Details Value Author(s) Examples

View source: R/All.R

Description

Quantifies the heterogeneity of a pooled group

Usage

1
H2(x)

Arguments

x

pooling group derived from the Pool() function

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

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

Example output

[1] "8.09"                                                              
[2] "Group is strongly heterogenous: a review of the group is essential"

UKFE documentation built on Jan. 27, 2022, 5:07 p.m.

Related to H2 in UKFE...