Learn R Programming

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

UKFE (version 0.1.1)

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 packages uses NRFA peak flow dataset version 9. 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 <80><98>extreme rank plot<80><99> 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). "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.1.1

License

GPL-3

Maintainer

Last Published

November 24th, 2020

Functions in UKFE (0.1.1)

ERPlot

Extreme rank plot
AMSP

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

FEH99 depth duration frequency precipitation model
AMplot

Plot of the annual maximum sample
BFI

Baseflow index (BFI)
DesHydro

Design hydrograph extraction
ARF

Areal reduction factor (ARF)
AMextract

Annual maximum extraction
DonAdj

Donor adjustment candidates & results
DiagPlots

Diagnostic plots for pooling groups
GEVPars

Generalised extreme value distribution parameter estimates
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GenLogGF

Generalised logistic distribution growth factors
GenLogEst

Generalised logistic distribution estimates from parameters
GenParetoGF

Generalised Pareto distribution growth factors
GEVEst

Generalised extreme value distribution estimates from parameters
GoTF

Goodness of tail fit (GoTF).
GEVGF

Generalised extreme value distribution growth factors
GoTFPool

Goodness of tail fit (GoTF) for pooling groups
Lcv

Linear coefficient of variation (Lcv)
LSkewUrb

Urban adjustment for the linear skewness (LSkew)
GenLogAM

Generalised logistic distribution - estimates directly from sample
H2

Heterogeneity measure (H2) for pooling groups.
HydroPlot

Hydrological plot of concurrent discharge and precipitation
GenLogPars

Generalised logistic distribution parameter estimates
GetAM

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

Linear Kurtosis (LKurt)
LSkew

Linear Skewness (LSkew)
GenParetoPars

Generalised Pareto distribution parameter estimates
GetCDs

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

Generalised extreme value distribution - estimates directly from sample
EncProb

Encounter probabilities
GenParetoEst

Generalised Pareto distribution estimates from parameters
EVPlot

Extreme value plot (frequency and growth curves)
QMEDDonEq

QMED donor adjustment
QMED

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

Import catchment descriptors from .CD3 files
ImportAM

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

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

Extreme value plot for pooling groups
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
UAF

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

Gauged pool weighted linear coefficient of variation (Lcv)
TrendTest

Trend hypothesis test
Pool

Create pooling group
SCF

Seasonal correction factor (SCF)
UKOutline

UK outline
ReFH

Revitalised Flood Hydrograph Model (ReFH)
PoolEst

Pooled flood estimates
QMEDLink

QMED Linking equation
QuickResults

Quick pooled results
GetQMED

QMED from a gauged site suitable for QMED
LcvUrb

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

Optimise distribution parameters
QMEDPOT

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

Peaks over threshold (POT) data extraction
QMEDfseSS

QMED factorial standard error for gauged sites
WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
UncSS

Uncertainty for the single site
Zdists

Zdist Goodness of fit measure for pooling groups
NGRDist

British national grid reference (NGR) distances
Lmoms

Lmoments & Lmoment ratios
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
Rating

Stage-Discharge equation optimisation
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
NRFAData

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

Site ungauged linear skewness (LSkew) weightings
ThamesPQ

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

Data simulator
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings