UKFE (version 0.1.1)

QuickResults: Quick pooled results

Description

Provides pooled gauged, ungauged, or fake ungauged results, directly from the catchment descriptors

Usage

QuickResults(
  CDs,
  gauged = FALSE,
  dons = 2,
  Qmed = NULL,
  trend = FALSE,
  FUngauged = FALSE,
  plot = TRUE,
  dist = "GenLog"
)

Arguments

CDs

catchment descriptors derived from either GetCDs or ImportCDs

gauged

logical argument with a default of FALSE. TRUE for gauged results and FALSE for ungauged

dons

number of donors required with a choice of 0, 1, or 2

Qmed

user supplied QMED which overrides the default QMED estimate

trend

logical argument with a default of FALSE. TRUE adjusts the stationary QMED estimate to a non-stationary estimate

FUngauged

logical argument with a default of FALSE. TRUE provides an ungauged estimate whilst excluding the gauged site (the site with the most similar CDs)

plot

logical argument with a default of TRUE. TRUE provides an extreme value plot. FALSE prevents the plot

dist

a choice of distribution for the estimates. The choices are "GenLog" or "GEV" the generalised logistic and the generalised extreme value distribution, respectively. The default is "GenLog"

Value

A list of length two. Element one is a data frame with columns; return period (RP), peak flow estimates (Q) and growth factor estimates (GF). The second element is the estimated Lcv and Lskew (linear coefficient of variation and skewness). By default an extreme value plot is also returned

Details

The quick results function provides results with a default pooling group. If gauged = FALSE the median annual maximum flood (QMED) is estimated from catchment descriptors using the QMED equation and then adjusted with two of the closest un-urban gauged sites (can be changed to 0 or 1 donors). If the site is urban, an urban adjustment is made to the QMED and to the pooled growth curve. If gauged = TRUE QMED is the median of the gauged annual maxima and the growth curve is formed with the gauged weighting procedure (often known as enhanced single site). If the gauged catchment is urban, it's included in the pooling group and deurbanised before an urban adjustment is made to the final growth curve. If FUngauged = TRUE, the top site in the pooling group is excluded and the estimate is performed henceforth in the manner of gauged = FALSE. If the CDs are from a gauged site that is not in the list of sites that are considered suitable for pooling, it won't be included in the pooling group. In which case, if gauged = TRUE, the result, will be erroneous. For more details of the trend argument see the details for the PoolEst function.

Examples

# NOT RUN {
#Get some catchment descriptors
CDs.73005 <- GetCDs(73005)
#Get default ungauged results
QuickResults(CDs.73005)
#Get gauged results with a GEV distribution
QuickResults(CDs.73005, gauged = TRUE, dist = "GEV")
#Get fake ungauged results with one donor
QuickResults(CDs.73005, FUngauged = TRUE, dons = 1)


# }