PoolSmall: Create pooling group for small catchments

In UKFE: UK Flood Estimation

Create pooling group for small catchments

Description

Function to develop a small catchments pooling group based on catchment descriptors

Usage

PoolSmall(
  CDs = NULL,
  AREA,
  SAAR,
  N = 500,
  exclude = NULL,
  iug = FALSE,
  UrbMax = 0.03,
  DeUrb = FALSE
)

Arguments

CDs	catchment descriptors derived from either GetCDs or CDsXML
AREA	catchment area in km2
SAAR	catchment standard average annual rainfall (1961-1990) in mm
N	minimum Number of total gauged record years for the pooling group
exclude	sites to exclude from the pooling group. Either a single site reference or a vector of site references (numeric)
iug	iug stands for 'include urban gauge' - which refers to a gauged subject site if it's > UrbMax. It's a logical argument with default of FALSE. TRUE will over-ride the default and add the closest site in catchment descriptor space (should be the gauge of interest) to the pooling group if it has URBEXT2000 >= UrbMax
UrbMax	Maximum URBEXT2000 level with a default of 0.03. Any catchment with URBEXT2000 above this level will be excluded from the pooling group
DeUrb	logical argument with a default of FALSE. If true, the Lcv and LSkew of any site in the pooling group with URBEXT2000 > 0.03 will be de-urbanised

Details

A pooling group is created from a CDs object, derived from GetCDs or CDsXML, or specifically with the necessary catchment descriptors (see arguments). To change the default pooling group one or more sites can be excluded using the 'exclude' option, which requires either a site reference or multiple site references in a vector. If this is done, the site with the next lowest similarity distance measure is added to the group (until the total number of years is at least N). Sites with URBEXT2000 (urban extent) > 0.03 are excluded by default and this can be adjusted with the UrbMax argument. If a gauged assessment is required and the site of interest is > UrbMax it can be included by setting iug = TRUE. De-urbanise the Lcv and Lskew (L-moment ratios) of sites with URBEXT2000 > 0.03 by setting DeUrb = TRUE. If the user has more data available for a particular site within the pooling group, the Lcv and Lskew for the site can be updated after the group has been finalised.

Value

A data.frame of the pooling group with site reference row names and 24 columns, each providing catchment & gauge details for the sites in the pooling group.

Author(s)

Anthony Hammond

Examples

#Get some catchment descriptors
CDs.21001 <- GetCDs(21001)
#Set up a pooling group object called Pool.21001 excluding site 206006
#Then print the group to the console
Pool.21001 <- PoolSmall(CDs.21001, exclude = 206006)
Pool.21001
#Form a pooling group, called PoolGroup, with the catchment descriptors specifically
PoolGroup <- PoolSmall(AREA = 22, SAAR = 1702)

UKFE documentation built on Nov. 6, 2023, 1:07 a.m.