Learn R Programming

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

UKFE (version 0.3.9)

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

322

Version

0.3.9

License

GPL-3

Maintainer

Anthony Hammond

Last Published

January 9th, 2025

Functions in UKFE (0.3.9)

DesHydro

Design hydrograph extraction
EVPlotAdd

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

Generalised extreme value distribution estimates from parameters
EVPool

Extreme value plot for pooling groups
DonAdj

Donor adjustment candidates & results
EncProb

Encounter probabilities
FlowDurationCurve

Flow duration curve
GetAM

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

Generalised Pareto distribution parameter estimates
GEVPars

Generalised extreme value distribution parameter estimates
GenLogAM

Generalised logistic distribution - estimates directly from sample
GenParetoGF

Generalised Pareto distribution growth factors
GEVAM

Generalised extreme value distribution - estimates directly from sample
FlowSplit

Flow splitter
GenParetoPOT

Generalised Pareto 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.
GetDataEA_QH

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

Generalised logistic distribution parameter estimates
GenParetoEst

Generalised Pareto distribution estimates from parameters
GoFComparePool

Goodness of fit comparison (for a pooling group)
GoFCompare

Goodness of fit comparison (single sample)
Kappa3GF

Kappa3 distribution growth factors
GetDataSEPA_QH

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

Kappa3 distribution parameter estimates
GEVGF

Generalised extreme value distribution growth factors
GetDataNRFA

Get National River Flow Archive data using gauge ID.
ERPlot

Extreme rank plot
Kappa3AM

Kappa3 distribution - estimates directly from sample
Kappa3Est

Kappa3 distribution estimates from parameters
Lcv

Linear coefficient of variation (Lcv)
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
NRFAData

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

British national grid reference (NGR) distances
GetDataSEPA_Rain

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

Linear Skewness (LSkew)
GetQMED

QMED from a gauged site suitable for QMED
LcvUrb

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

Gumbel distribution estimates from parameters
GumbelAM

Gumbel distribution - estimates directly from sample
QMED

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

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

Extreme value plot (frequency and growth curves)
MonthlyStats

Monthly Statistics
GumbelPars

Gumbel distribution parameter estimates
GumbelGF

Gumbel distribution growth factors
Pool

Create pooling group
LKurt

Linear Kurtosis (LKurt)
POTextract

Peaks over threshold (POT) data extraction
LRatioChange

Adjust L-Ratios in a pooling group
OptimPars

Optimise distribution parameters
LMoments

Lmoments & Lmoment ratios
GenLogEst

Generalised logistic distribution estimates from parameters
GetDataEA_Rain

Get Environment Agency rainfall data (England).
GenLogGF

Generalised logistic distribution growth factors
H2

Heterogeneity measure (H2) for pooling groups.
HydroPlot

Hydrological plot of concurrent discharge and precipitation
GetDataMetOffice

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

Pooled flood estimates
PoolSmall

Create pooling group for small catchments
QMEDPOT

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

Revitalised Flood Hydrograph Model (ReFH)
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
ThamesPQ

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

Data simulator
QuickResults

Quick pooled results
NonFloodAdjPool

Non-flood adjustment for pooling groups
NonFloodAdj

Non-flood adjustment
SCF

Seasonal correction factor (SCF)
Rating

Stage-Discharge equation optimisation
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
QMEDDonEq

QMED donor adjustment
POTt

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

QMED Linking equation
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
QMEDfseSS

QMED factorial standard error for gauged sites
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
UEF

Urban expansion factor
UKOutline

UK outline
Zdists

Zdist Goodness of fit measure for pooling groups
TrendTest

Trend hypothesis test
UAF

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

Annual statistics extraction
ARF

Areal reduction factor (ARF)
AMplot

Plot of the annual maximum sample
AddGauge

Add an AMAX sample
AMSP

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

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

Aggregate a time series
Bootstrap

Bootstrap
BFI

Baseflow index (BFI)
CDsXML

Import catchment descriptors from .xml files
DiagPlots

Diagnostic plots for pooling groups
DeTrend

Linearly detrend a sample
DDFExtract

Derive and plot rainfall Depth Duration Frequency curves.
DDF

DDF results from a DDFImport object
ConvertGridRef

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

DDF13 or DDF22 results from .xml files
DDF99

FEH99 depth duration frequency precipitation model
DDF99Pars

DDF99 parameters from .xml files