Learn R Programming

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

UKFE (version 0.2.7)

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

325

Version

0.2.7

License

GPL-3

Maintainer

Anthony Hammond

Last Published

February 3rd, 2023

Functions in UKFE (0.2.7)

DonAdj

Donor adjustment candidates & results
DesHydro

Design hydrograph extraction
DeTrend

Linearly detrend a sample
DDF99Pars

DDF99 parameters from .xml files
EVPool

Extreme value plot for pooling groups
DiagPlots

Diagnostic plots for pooling groups
GenLogPars

Generalised logistic distribution parameter estimates
GenLogGF

Generalised logistic distribution growth factors
ERPlot

Extreme rank plot
EVPlot

Extreme value plot (frequency and growth curves)
GenLogEst

Generalised logistic distribution estimates from parameters
EVPlotAdd

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

Generalised logistic distribution - estimates directly from sample
EncProb

Encounter probabilities
GEVPars

Generalised extreme value distribution parameter estimates
GEVGF

Generalised extreme value distribution growth factors
GoTF

Goodness of tail fit (GoTF).
GetQMED

QMED from a gauged site suitable for QMED
GenParetoEst

Generalised Pareto distribution estimates from parameters
HydroPlot

Hydrological plot of concurrent discharge and precipitation
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GEVEst

Generalised extreme value distribution estimates from parameters
GenParetoPars

Generalised Pareto distribution parameter estimates
GEVAM

Generalised extreme value distribution - estimates directly from sample
GumbelPars

Gumbel distribution parameter estimates
GumbelGF

Gumbel distribution growth factors
GumbelEst

Gumbel distribution estimates from parameters
LKurt

Linear Kurtosis (LKurt)
GumbelAM

Gumbel distribution - estimates directly from sample
GoTFPool

Goodness of tail fit (GoTF) for pooling groups
GenParetoGF

Generalised Pareto distribution growth factors
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
LSkew

Linear Skewness (LSkew)
GetAM

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

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

Create pooling group for small catchments
PoolEst

Pooled flood estimates
Lmoms

Lmoments & Lmoment ratios
H2

Heterogeneity measure (H2) for pooling groups.
MonthlyStats

Monthly Statistics
NRFAData

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

British national grid reference (NGR) distances
Rating

Stage-Discharge equation optimisation
QuickResults

Quick pooled results
LRatioChange

Adjust L-Ratios in a pooling group
Pool

Create pooling group
PermAdj

Permeable Adjustment
POTextract

Peaks over threshold (POT) data extraction
QMEDDonEq

QMED donor adjustment
OptimPars

Optimise distribution parameters
Kappa3GF

Kappa3 distribution growth factors
UAF

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

Trend hypothesis test
SimData

Data simulator
ThamesPQ

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

QMED factorial standard error for gauged sites
QMEDPOT

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

Uncertainty for the single site
LcvUrb

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

Linear coefficient of variation (Lcv)
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
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
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
QMEDLink

QMED Linking equation
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
UEF

Urban expansion factor
ReFH

Revitalised Flood Hydrograph Model (ReFH)
Zdists

Zdist Goodness of fit measure for pooling groups
SCF

Seasonal correction factor (SCF)
UKOutline

UK outline
AMextract

Annual maximum extraction
CDsXML

Import catchment descriptors from .xml files
AMImport

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

Plot of the annual maximum sample
DDF13Import

DDF13 results from .xml files
DDF99

FEH99 depth duration frequency precipitation model
DDF13

DDF13 results from a DDF13Import object
ARF

Areal reduction factor (ARF)
AMSP

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

Baseflow index (BFI)