Learn R Programming

UKFE (version 2.0.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 14. 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). "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, ). "The FEH 2025 statistical method update", UK Centre for Ecology and Hydrology (2025). "Low flow estimation in the United Kingdom", Institute of Hydrology (1992, ISBN 0 948540 45 1). Data from the UK National River Flow Archive (, terms and conditions: ).

Copy Link

Version

Install

install.packages('UKFE')

Monthly Downloads

240

Version

2.0.0

License

GPL-3

Maintainer

Anthony Hammond

Last Published

October 28th, 2025

Functions in UKFE (2.0.0)

EVPlot

Extreme value plot (frequency and growth curves)
CDsXML_Legacy

Import catchment descriptors from older .xml files
GEVEst

Generalised extreme value distribution estimates from parameters
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GenParetoPars

Generalised Pareto distribution parameter estimates
DonAdj

Donor adjustment candidates
ERPlot

Extreme rank plot
GenLogEst

Generalised logistic distribution estimates from parameters
GenLogAM

Generalised logistic distribution - estimates directly from sample
GetCDs

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

Extreme value plot for pooling groups
EncProb

Encounter probabilities
GenLogPars

Generalised logistic distribution parameter estimates
GenLogGF

Generalised logistic distribution growth factors
GetAM

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

Gumbel distribution growth factors
GoFCompare

Goodness of fit comparison (single sample)
GoFComparePool

Goodness of fit comparison (for a pooling group)
GEVGF

Generalised extreme value distribution growth factors
GenParetoGF

Generalised Pareto distribution growth factors
ConvertGridRef

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

QMED from a gauged site suitable for QMED
EVPlotAdd

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

Generalised Pareto distribution estimates from parameters
GetDataSEPA

Get Scottish Environment Protection Agency (SEPA) Flow, Level, or Rainfall data.
GetDataEA_QH

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

Kappa3 distribution estimates from parameters
Kappa3AM

Kappa3 distribution - estimates directly from sample
LcvUrb

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

Hydrological plot of concurrent discharge and precipitation
GetDataEA_Rain

Get Environment Agency rainfall data (England).
LSkew

Linear Skewness (LSkew)
GumbelPars

Gumbel distribution parameter estimates
FlowSplit

Flow splitter
FlowDurationCurve

Flow duration curve
PeakFlowData

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

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

Low Flows
Lcv

Linear coefficient of variation (Lcv)
GetDataNRFA

Get National River Flow Archive data using gauge ID.
GetDataMetOffice

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

Peaks over threshold (POT) data extraction
SCF

Seasonal correction factor (SCF)
OptimPars

Optimise distribution parameters
Seasonality

Seasonality plot
WeightsLSKEW

Linear Skewness (LSKEW) weightings for a pooling group
WeightsLCV

Linear coefficient of variation (Lcv) weightings for a pooling group
H2

Heterogeneity measure (H2) for pooling groups.
Kappa3Pars

Kappa3 distribution parameter estimates
GEVPars

Generalised extreme value distribution parameter estimates
HistoricMLE

Historic flood maximum likelihood estimation
LKurt

Linear Kurtosis (LKurt)
QuickResults

Quick pooled results
QMEDfseSS

QMED factorial standard error for gauged sites
Pool

Create pooling group
LMoments

Lmoments & Lmoment ratios
LRatioChange

Adjust L-Ratios in a pooling group
Kappa3GF

Kappa3 distribution growth factors
NonFloodAdj

Non-flood adjustment
NonFloodAdjPool

Non-flood adjustment for pooling groups
SimData

Data simulator
PoolEst

Pooled flood estimates
UKOutline

UK outline
UEF

Urban expansion factor
ThamesPQ

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

Weighted Lmoment ratios (LCV and LSKEW) from a pooling group
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
TrendTest

Trend hypothesis test
UAF

Urban adjustment factor (UAF)
QMEDDonEq

QMED donor adjustment
QMED

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

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

QMED Linking equation
Zdists

Zdist Goodness of fit measure for pooling groups
MonthlyStats

Monthly Statistics
Rating

Stage-Discharge equation optimisation
GumbelAM

Gumbel distribution - estimates directly from sample
NGRDist

British national grid reference (NGR) distances
ReFH

Revitalised Flood Hydrograph Model (ReFH)
GumbelEst

Gumbel distribution estimates from parameters
AMImport

Import an annual maximum (AMAX) sample from NRFA peak flow .am files
ARF

Areal reduction factor (ARF)
AMplot

Plot of the annual maximum sample
AggDayHour

Aggregate a time series
Bootstrap

Bootstrap
AMPF

National River Flow Archive (NRFA) annual maximum peak flow data for sites suitable for QMED only, and those for pooling.
BFI

Baseflow index (BFI)
AnnualStat

Annual statistics extraction
CDsXML

Import catchment descriptors from .xml files
AddGauge

Add an AMAX sample
DiagPlots

Diagnostic plots for pooling groups
DesHydro

Design hydrograph extraction
DDF99

FEH99 depth duration frequency precipitation model
DDF

DDF results from a DDFImport object
DDF99Pars

DDF99 parameters from .xml files
DDFImport

DDF13 or DDF22 results from .xml files
DeTrend

Linearly detrend a sample
GEVAM

Generalised extreme value distribution - estimates directly from sample
DDFExtract

Derive and plot rainfall Depth Duration Frequency curves.