Learn R Programming

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

UKFE (version 0.3.6)

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

352

Version

0.3.6

License

GPL-3

Maintainer

Anthony Hammond

Last Published

September 10th, 2024

Functions in UKFE (0.3.6)

AMImport

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

Plot of the annual maximum sample
GetCDs

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

Generalised logistic distribution - estimates directly from sample
GenLogEst

Generalised logistic distribution estimates from parameters
GetAM

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

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

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

Generalised extreme value distribution parameter estimates
EVPlot

Extreme value plot (frequency and growth curves)
GEVGF

Generalised extreme value distribution growth factors
GetNRFA

Get National River Flow Archive data using gauge ID.
HydroPlot

Hydrological plot of concurrent discharge and precipitation
DonAdj

Donor adjustment candidates & results
ERPlot

Extreme rank plot
GumbelGF

Gumbel distribution growth factors
GumbelEst

Gumbel distribution estimates from parameters
NGRDist

British national grid reference (NGR) distances
Kappa3Est

Kappa3 distribution estimates from parameters
DesHydro

Design hydrograph extraction
MonthlyStats

Monthly Statistics
GumbelPars

Gumbel distribution parameter estimates
Kappa3GF

Kappa3 distribution growth factors
QMEDfseSS

QMED factorial standard error for gauged sites
QuickResults

Quick pooled results
H2

Heterogeneity measure (H2) for pooling groups.
AMSP

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

DDF13 or DDF22 results from .xml files
GenParetoEst

Generalised Pareto distribution estimates from parameters
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
POTt

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

Generalised logistic distribution growth factors
QMEDLink

QMED Linking equation
GenLogPars

Generalised logistic distribution parameter estimates
POTextract

Peaks over threshold (POT) data extraction
Kappa3AM

Kappa3 distribution - estimates directly from sample
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
DiagPlots

Diagnostic plots for pooling groups
DeTrend

Linearly detrend a sample
Lmoms

Lmoments & Lmoment ratios
QMEDPOT

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

Generalised Pareto distribution growth factors
LcvUrb

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

Gauged pool weighted linear skewness (LSkew)
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
NonFloodAdjPool

Non-flood adjustment for pooling groups
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
OptimPars

Optimise distribution parameters
ThamesPQ

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

Site ungauged linear coefficient of variation (Lcv) weightings
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
TrendTest

Trend hypothesis test
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
Zdists

Zdist Goodness of fit measure for pooling groups
Kappa3Pars

Kappa3 distribution parameter estimates
GetRainSEPA

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

Goodness of fit comparison (single sample)
LKurt

Linear Kurtosis (LKurt)
QMEDData

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

Generalised extreme value distribution - estimates directly from sample
QMEDDonEq

QMED donor adjustment
GEVEst

Generalised extreme value distribution estimates from parameters
GetQMED

QMED from a gauged site suitable for QMED
GetRainEA

Get Environment Agency rainfall data (England).
GenParetoPars

Generalised Pareto distribution parameter estimates
SCF

Seasonal correction factor (SCF)
GoFComparePool

Goodness of fit comparison (for a pooling group)
LRatioChange

Adjust L-Ratios in a pooling group
LSkew

Linear Skewness (LSkew)
Pool

Create pooling group
SimData

Data simulator
GumbelAM

Gumbel distribution - estimates directly from sample
PoolEst

Pooled flood estimates
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
PoolSmall

Create pooling group for small catchments
Lcv

Linear coefficient of variation (Lcv)
QMED

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

Non-flood adjustment
UAF

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

Stage-Discharge equation optimisation
UKOutline

UK outline
UEF

Urban expansion factor
ReFH

Revitalised Flood Hydrograph Model (ReFH)
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
UncSS

Uncertainty for the single site
NRFAData

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

Site gauged linear skewness (LSkew) weightings
CDsXML

Import catchment descriptors from .xml files
AddGauge

Add an AMAX sample
ARF

Areal reduction factor (ARF)
DDF

DDF results from a DDFImport object
AggDayHour

Aggregate a time series
BFI

Baseflow index (BFI)
AMextract

Annual maximum extraction
DDF99

FEH99 depth duration frequency precipitation model
DDF99Pars

DDF99 parameters from .xml files
EVPool

Extreme value plot for pooling groups
EncProb

Encounter probabilities