Learn R Programming

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

UKFE (version 0.3.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 12.1. 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.3.4

License

GPL-3

Maintainer

Last Published

March 3rd, 2024

Functions in UKFE (0.3.4)

DDFImport

DDF13 or DDF22 results from .xml files
EVPlot

Extreme value plot (frequency and growth curves)
EVPlotAdd

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

Linearly detrend a sample
EVPool

Extreme value plot for pooling groups
GenLogGF

Generalised logistic distribution growth factors
GenLogEst

Generalised logistic distribution estimates from parameters
GenLogPars

Generalised logistic distribution parameter estimates
GenParetoEst

Generalised Pareto distribution estimates from parameters
GEVGF

Generalised extreme value distribution growth factors
GenParetoGF

Generalised Pareto distribution growth factors
GumbelAM

Gumbel distribution - estimates directly from sample
GEVAM

Generalised extreme value distribution - estimates directly from sample
DesHydro

Design hydrograph extraction
EncProb

Encounter probabilities
GetAM

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

Generalised Pareto distribution parameter estimates
GenLogAM

Generalised logistic distribution - estimates directly from sample
GumbelEst

Gumbel distribution estimates from parameters
GEVEst

Generalised extreme value distribution estimates from parameters
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GEVPars

Generalised extreme value distribution parameter estimates
H2

Heterogeneity measure (H2) for pooling groups.
Kappa3GF

Kappa3 distribution growth factors
GumbelGF

Gumbel distribution growth factors
LKurt

Linear Kurtosis (LKurt)
NGRDist

British national grid reference (NGR) distances
MonthlyStats

Monthly Statistics
GumbelPars

Gumbel distribution parameter estimates
GetQMED

QMED from a gauged site suitable for QMED
Lcv

Linear coefficient of variation (Lcv)
QMEDDonEq

QMED donor adjustment
LcvUrb

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

Lmoments & Lmoment ratios
NonFloodAdj

Non-flood adjustment
NRFAData

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

Hydrological plot of concurrent discharge and precipitation
QMED

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

Non-flood adjustment for pooling groups
GoTF

Goodness of tail fit (GoTF).
LRatioChange

Adjust L-Ratios in a pooling group
QMEDLink

QMED Linking equation
LSkew

Linear Skewness (LSkew)
GetCDs

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

Goodness of tail fit (GoTF) for pooling groups
QMEDData

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

Revitalised Flood Hydrograph Model (ReFH)
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
QuickResults

Quick pooled results
TrendTest

Trend hypothesis test
RainEA

Get Environment Agency rainfall data (England).
OptimPars

Optimise distribution parameters
PoolEst

Pooled flood estimates
PoolSmall

Create pooling group for small catchments
QMEDfseSS

QMED factorial standard error for gauged sites
Rating

Stage-Discharge equation optimisation
QMEDPOT

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

Create pooling group
POTextract

Peaks over threshold (POT) data extraction
RainSEPA

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

Site ungauged linear skewness (LSkew) weightings
UAF

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

Gauged pool weighted linear skewness (LSkew)
SCF

Seasonal correction factor (SCF)
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
UEF

Urban expansion factor
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
SimData

Data simulator
UncSS

Uncertainty for the single site
ThamesPQ

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

Ungauged pool weighted linear skewness (LSkew)
Zdists

Zdist Goodness of fit measure for pooling groups
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
UKOutline

UK outline
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
BFI

Baseflow index (BFI)
AMextract

Annual maximum extraction
AMSP

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

DDF results from a DDFImport object
AMImport

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

Plot of the annual maximum sample
ARF

Areal reduction factor (ARF)
DDF99

FEH99 depth duration frequency precipitation model
AggDayHour

Aggregate a time series
CDsXML

Import catchment descriptors from .xml files
DDF99Pars

DDF99 parameters from .xml files
DonAdj

Donor adjustment candidates & results
DiagPlots

Diagnostic plots for pooling groups
ERPlot

Extreme rank plot