Learn R Programming

UKFE (version 0.4.0)

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 13. 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

369

Version

0.4.0

License

GPL-3

Maintainer

Anthony Hammond

Last Published

February 9th, 2025

Functions in UKFE (0.4.0)

DDF99

FEH99 depth duration frequency precipitation model
DesHydro

Design hydrograph extraction
DDF99Pars

DDF99 parameters from .xml files
DDF

DDF results from a DDFImport object
DonAdj

Donor adjustment candidates & results
DDFImport

DDF13 or DDF22 results from .xml files
GEVAM

Generalised extreme value distribution - estimates directly from sample
DDFExtract

Derive and plot rainfall Depth Duration Frequency curves.
FlowSplit

Flow splitter
GEVEst

Generalised extreme value distribution estimates from parameters
GEVGF

Generalised extreme value distribution growth factors
GenLogEst

Generalised logistic distribution estimates from parameters
GenParetoGF

Generalised Pareto distribution growth factors
EncProb

Encounter probabilities
GenLogGF

Generalised logistic distribution growth factors
FlowDurationCurve

Flow duration curve
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
EVPlotAdd

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

Generalised logistic distribution parameter estimates
GenParetoEst

Generalised Pareto distribution estimates from parameters
EVPool

Extreme value plot for pooling groups
GetAM

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

Generalised Pareto distribution parameter estimates
GetDataNRFA

Get National River Flow Archive data using gauge ID.
GoFCompare

Goodness of fit comparison (single sample)
GoFComparePool

Goodness of fit comparison (for a pooling group)
GetQMED

QMED from a gauged site suitable for QMED
GetDataSEPA_Rain

Get Scottish Environment Protection Agency (SEPA) hourly rainfall data.
GetDataSEPA_QH

Get flow or level data from the Scottish Environmental Protection Agency.
GetDataMetOffice

Get regional Met Office average temperature or rainfall series (monthly, seasonal, and annual).
GetDataEA_Rain

Get Environment Agency rainfall data (England).
H2

Heterogeneity measure (H2) for pooling groups.
LcvUrb

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

Urban adjustment for the linear skewness (LSkew)
Lcv

Linear coefficient of variation (Lcv)
Kappa3Est

Kappa3 distribution estimates from parameters
MonthlyStats

Monthly Statistics
HydroPlot

Hydrological plot of concurrent discharge and precipitation
Kappa3AM

Kappa3 distribution - estimates directly from sample
ERPlot

Extreme rank plot
EVPlot

Extreme value plot (frequency and growth curves)
GEVPars

Generalised extreme value distribution parameter estimates
GenLogAM

Generalised logistic distribution - estimates directly from sample
GumbelPars

Gumbel distribution parameter estimates
GumbelAM

Gumbel distribution - estimates directly from sample
GumbelGF

Gumbel distribution growth factors
GumbelEst

Gumbel distribution estimates from parameters
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
GetCDs

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

Linear Kurtosis (LKurt)
LMoments

Lmoments & Lmoment ratios
SimData

Data simulator
PoolEst

Pooled flood estimates
QMEDLink

QMED Linking equation
QMEDDonEq

QMED donor adjustment
Pool

Create pooling group
ThamesPQ

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

Adjust L-Ratios in a pooling group
LSkew

Linear Skewness (LSkew)
OptimPars

Optimise distribution parameters
GetDataEA_QH

Get flow or level data from the Environment Agency's Hydrology Data Explorer
POTt

Peaks over threshold (POT) data extraction (quick)
Kappa3GF

Kappa3 distribution growth factors
NGRDist

British national grid reference (NGR) distances
UEF

Urban expansion factor
Kappa3Pars

Kappa3 distribution parameter estimates
UKOutline

UK outline
POTextract

Peaks over threshold (POT) data extraction
PoolSmall

Create pooling group for small catchments
SCF

Seasonal correction factor (SCF)
ReFH

Revitalised Flood Hydrograph Model (ReFH)
QMEDPOT

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

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

Uncertainty quantification for gauged and ungauged pooled estimates
Rating

Stage-Discharge equation optimisation
QuickResults

Quick pooled results
QMEDfseSS

QMED factorial standard error for gauged sites
NonFloodAdjPool

Non-flood adjustment for pooling groups
NonFloodAdj

Non-flood adjustment
UAF

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

Trend hypothesis test
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
Zdists

Zdist Goodness of fit measure for pooling groups
ARF

Areal reduction factor (ARF)
AMImport

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

Baseflow index (BFI)
Bootstrap

Bootstrap
AggDayHour

Aggregate a time series
AMplot

Plot of the annual maximum sample
AddGauge

Add an AMAX sample
CDsXML

Import catchment descriptors from .xml files
AMSP

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

Annual statistics extraction
DiagPlots

Diagnostic plots for pooling groups
DeTrend

Linearly detrend a sample
ConvertGridRef

Convert between British National Grid Reference (BNG) and Latitude and Longitude or Irish Grid references.