Learn R Programming

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

UKFE (version 0.2.8)

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

License

GPL-3

Maintainer

Last Published

March 12th, 2023

Functions in UKFE (0.2.8)

GenLogEst

Generalised logistic distribution estimates from parameters
DiagPlots

Diagnostic plots for pooling groups
DesHydro

Design hydrograph extraction
GenParetoEst

Generalised Pareto distribution estimates from parameters
GenLogAM

Generalised logistic distribution - estimates directly from sample
GenParetoGF

Generalised Pareto distribution growth factors
GEVGF

Generalised extreme value distribution growth factors
GEVPars

Generalised extreme value distribution parameter estimates
AMextract

Annual maximum extraction
GetQMED

QMED from a gauged site suitable for QMED
GoTF

Goodness of tail fit (GoTF).
AMplot

Plot of the annual maximum sample
ERPlot

Extreme rank plot
DonAdj

Donor adjustment candidates & results
GetCDs

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

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

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

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

Generalised logistic distribution growth factors
GenLogPars

Generalised logistic distribution parameter estimates
GumbelEst

Gumbel distribution estimates from parameters
EVPlot

Extreme value plot (frequency and growth curves)
H2

Heterogeneity measure (H2) for pooling groups.
GumbelPars

Gumbel distribution parameter estimates
NGRDist

British national grid reference (NGR) distances
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GenParetoPars

Generalised Pareto distribution parameter estimates
NRFAData

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

Create pooling group for small catchments
PoolEst

Pooled flood estimates
Lmoms

Lmoments & Lmoment ratios
MonthlyStats

Monthly Statistics
LRatioChange

Adjust L-Ratios in a pooling group
LKurt

Linear Kurtosis (LKurt)
GumbelGF

Gumbel distribution growth factors
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
LSkew

Linear Skewness (LSkew)
Lcv

Linear coefficient of variation (Lcv)
HydroPlot

Hydrological plot of concurrent discharge and precipitation
Kappa3GF

Kappa3 distribution growth factors
EVPlotAdd

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

QMED donor adjustment
QMEDLink

QMED Linking equation
LcvUrb

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

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

Trend hypothesis test
QMEDPOT

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

Uncertainty for the single site
QMEDfseSS

QMED factorial standard error for gauged sites
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
QMED

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

Gauged pool weighted linear coefficient of variation (Lcv)
SCF

Seasonal correction factor (SCF)
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
PermAdj

Permeable Adjustment
GEVAM

Generalised extreme value distribution - estimates directly from sample
GEVEst

Generalised extreme value distribution estimates from parameters
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
ReFH

Revitalised Flood Hydrograph Model (ReFH)
Pool

Create pooling group
QMEDData

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

Gauged pool weighted linear skewness (LSkew)
SimData

Data simulator
Zdists

Zdist Goodness of fit measure for pooling groups
GoTFPool

Goodness of tail fit (GoTF) for pooling groups
GumbelAM

Gumbel distribution - estimates directly from sample
POTextract

Peaks over threshold (POT) data extraction
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
ThamesPQ

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

Optimise distribution parameters
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
QuickResults

Quick pooled results
UKOutline

UK outline
UEF

Urban expansion factor
Rating

Stage-Discharge equation optimisation
ARF

Areal reduction factor (ARF)
DDF99

FEH99 depth duration frequency precipitation model
CDsXML

Import catchment descriptors from .xml files
DDF99Pars

DDF99 parameters from .xml files
DDF

DDF results from a DDFImport object
BFI

Baseflow index (BFI)
DDFImport

DDF13 or DDF22 results from .xml files
EVPool

Extreme value plot for pooling groups
EncProb

Encounter probabilities
DeTrend

Linearly detrend a sample