Learn R Programming

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

UKFE (version 0.1.4)

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 9. 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). "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

322

Version

0.1.4

License

GPL-3

Maintainer

Anthony Hammond

Last Published

February 20th, 2021

Functions in UKFE (0.1.4)

AMplot

Plot of the annual maximum sample
DDF99

FEH99 depth duration frequency precipitation model
ARF

Areal reduction factor (ARF)
BFI

Baseflow index (BFI)
DiagPlots

Diagnostic plots for pooling groups
DonAdj

Donor adjustment candidates & results
GEVGF

Generalised extreme value distribution growth factors
AMSP

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

Generalised extreme value distribution parameter estimates
AMextract

Annual maximum extraction
GEVAM

Generalised extreme value distribution - estimates directly from sample
GenLogPars

Generalised logistic distribution parameter estimates
ERPlot

Extreme rank plot
GenLogGF

Generalised logistic distribution growth factors
GEVEst

Generalised extreme value distribution estimates from parameters
EVPlot

Extreme value plot (frequency and growth curves)
DeTrend

Linearly detrend a sample
GoTFPool

Goodness of tail fit (GoTF) for pooling groups
GetQMED

QMED from a gauged site suitable for QMED
GoTF

Goodness of tail fit (GoTF).
H2

Heterogeneity measure (H2) for pooling groups.
GenLogAM

Generalised logistic distribution - estimates directly from sample
DesHydro

Design hydrograph extraction
GenLogEst

Generalised logistic distribution estimates from parameters
POTextract

Peaks over threshold (POT) data extraction
Pool

Create pooling group
GenParetoEst

Generalised Pareto distribution estimates from parameters
GenParetoGF

Generalised Pareto distribution growth factors
GenParetoPars

Generalised Pareto distribution parameter estimates
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
QMEDLink

QMED Linking equation
OptimPars

Optimise distribution parameters
ImportAM

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

Stage-Discharge equation optimisation
HydroPlot

Hydrological plot of concurrent discharge and precipitation
NRFAData

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

Revitalised Flood Hydrograph Model (ReFH)
Lcv

Linear coefficient of variation (Lcv)
ImportCDs

Import catchment descriptors from .CD3 files
EVPool

Extreme value plot for pooling groups
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
Lmoms

Lmoments & Lmoment ratios
LKurt

Linear Kurtosis (LKurt)
NGRDist

British national grid reference (NGR) distances
EncProb

Encounter probabilities
QMEDfseSS

QMED factorial standard error for gauged sites
LcvUrb

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

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

Quick pooled results
UAF

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

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

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

Linear Skewness (LSkew)
UKOutline

UK outline
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
QMEDData

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

Seasonal correction factor (SCF)
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
SimData

Data simulator
UncSS

Uncertainty for the single site
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
QMEDDonEq

QMED donor adjustment
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
QMED

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

Pooled flood estimates
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
ThamesPQ

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

Site gauged linear skewness (LSkew) weightings
Zdists

Zdist Goodness of fit measure for pooling groups
TrendTest

Trend hypothesis test
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings