Learn R Programming

⚠️There's a newer version (0.3.7) of this package.Take me there.

UKFE (version 0.2.2)

UK Flood Estimation

Description

Functions to implement the methods of the Flood Estimation Handbook (FEH), associated updates and the revitalised flood hydrograph model (ReFH). Currently the package uses NRFA peak flow dataset version 10. Aside from FEH functionality, further hydrological functions are available. Most of the methods implemented in this package are described in one or more of the following: "Flood Estimation Handbook", Centre for Ecology & Hydrology (1999, ISBN:0 948540 94 X). "Flood Estimation Handbook Supplementary Report No. 1", Kjeldsen (2007, ISBN:0 903741 15 7). "Regional Frequency Analysis - an approach based on L-moments", Hosking & Wallis (1997, ISBN: 978 0 521 01940 8). "Proposal of the extreme rank plot for extreme value analysis: with an emphasis on flood frequency studies", Hammond (2019, ). "Making better use of local data in flood frequency estimation", Environment Agency (2017, ISBN: 978 1 84911 387 8). "Sampling uncertainty of UK design flood estimation" , Hammond (2021, ). "Improving the FEH statistical procedures for flood frequency estimation", Environment Agency (2008, ISBN: 978 1 84432 920 5). "Low flow estimation in the United Kingdom", Institute of Hydrology (1992, ISBN 0 948540 45 1). Wallingford HydroSolutions, (2016, ). Data from the UK National River Flow Archive (, terms and conditions: ).

Copy Link

Version

Install

install.packages('UKFE')

Monthly Downloads

627

Version

0.2.2

License

GPL-3

Maintainer

Last Published

January 27th, 2022

Functions in UKFE (0.2.2)

DiagPlots

Diagnostic plots for pooling groups
AMplot

Plot of the annual maximum sample
DeTrend

Linearly detrend a sample
ARF

Areal reduction factor (ARF)
DDF99

FEH99 depth duration frequency precipitation model
BFI

Baseflow index (BFI)
DonAdj

Donor adjustment candidates & results
AMSP

National River Flow Archive (NRFA) annual maximum data for sites suitable for pooling
DesHydro

Design hydrograph extraction
EVPlotAdd

Add lines and/or points to an extreme value plot
ERPlot

Extreme rank plot
GenParetoPars

Generalised Pareto distribution parameter estimates
GetAM

Get an annual maximum sample from the National River Flow Archive sites suitable for pooling
GoTF

Goodness of tail fit (GoTF).
AMextract

Annual maximum extraction
GoTFPool

Goodness of tail fit (GoTF) for pooling groups
EncProb

Encounter probabilities
GenLogEst

Generalised logistic distribution estimates from parameters
GumbelAM

Gumbel distribution - estimates directly from sample
GenLogGF

Generalised logistic distribution growth factors
GEVAM

Generalised extreme value distribution - estimates directly from sample
LKurt

Linear Kurtosis (LKurt)
GumbelEst

Gumbel distribution estimates from parameters
GenLogAM

Generalised logistic distribution - estimates directly from sample
HydroPlot

Hydrological plot of concurrent discharge and precipitation
QMEDfseSS

QMED factorial standard error for gauged sites
GEVPars

Generalised extreme value distribution parameter estimates
ReFH

Revitalised Flood Hydrograph Model (ReFH)
H2

Heterogeneity measure (H2) for pooling groups.
SCF

Seasonal correction factor (SCF)
QMEDPOT

Empirical estimate of QMED from peaks over threshold (POT) data
GEVEst

Generalised extreme value distribution estimates from parameters
LRatioChange

Adjust L-Ratios in a pooling group
QMEDDonEq

QMED donor adjustment
TrendTest

Trend hypothesis test
QMEDLink

QMED Linking equation
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
Zdists

Zdist Goodness of fit measure for pooling groups
GenParetoGF

Generalised Pareto distribution growth factors
GumbelGF

Gumbel distribution growth factors
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GEVGF

Generalised extreme value distribution growth factors
NGRDist

British national grid reference (NGR) distances
Lmoms

Lmoments & Lmoment ratios
UAF

Urban adjustment factor (UAF) and percentage runoff urban adjustment factor (PRUAF)
QMEDData

National River Flow Archive descriptors and calculated statistics for sites suitable for QMED & pooling
QMED

QMED (median annual maximum flow) estimate from catchment descriptors
EVPool

Extreme value plot for pooling groups
GetQMED

QMED from a gauged site suitable for QMED
ImportCDs

Import catchment descriptors from .CD3 files
GetCDs

Get catchment descriptors from the National River Flow Archive sites considered suitable for median annual maximum flow estimation (QMED).
ImportAM

Import an annual maximum (AMAX) sample from NRFA peak flow .AM files
LSkew

Linear Skewness (LSkew)
GenLogPars

Generalised logistic distribution parameter estimates
EVPlot

Extreme value plot (frequency and growth curves)
GenParetoEst

Generalised Pareto distribution estimates from parameters
QuickResults

Quick pooled results
GumbelPars

Gumbel distribution parameter estimates
POTextract

Peaks over threshold (POT) data extraction
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
Lcv

Linear coefficient of variation (Lcv)
PermAdj

Permeable Adjustment
Rating

Stage-Discharge equation optimisation
LcvUrb

Urban adjustment for the linear coefficient of variation (Lcv)
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
NRFAData

National River Flow Archive descriptors and calculated statistics for sites suitable for pooling
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
UKOutline

UK outline
UncSS

Uncertainty for the single site
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
OptimPars

Optimise distribution parameters
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
PoolEst

Pooled flood estimates
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
SimData

Data simulator
Pool

Create pooling group
ThamesPQ

Kingston upon Thames daily flow and catchment precipitation 2000-10-01 to 2015-09-30
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings