Learn R Programming

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

627

Version

0.3.7

License

GPL-3

Maintainer

Last Published

September 20th, 2024

Functions in UKFE (0.3.7)

DiagPlots

Diagnostic plots for pooling groups
GenLogAM

Generalised logistic distribution - estimates directly from sample
DesHydro

Design hydrograph extraction
GenLogEst

Generalised logistic distribution estimates from parameters
ERPlot

Extreme rank plot
GEVAM

Generalised extreme value distribution - estimates directly from sample
GetNRFA

Get National River Flow Archive data using gauge ID.
DDF99Pars

DDF99 parameters from .xml files
EncProb

Encounter probabilities
GenParetoEst

Generalised Pareto distribution estimates from parameters
GEVEst

Generalised extreme value distribution estimates from parameters
GetQMED

QMED from a gauged site suitable for QMED
GEVGF

Generalised extreme value distribution growth factors
GetCDs

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

Gumbel distribution estimates from parameters
GenParetoPOT

Generalised Pareto distribution - estimates directly from sample
GoFCompare

Goodness of fit comparison (single sample)
EVPool

Extreme value plot for pooling groups
GenParetoGF

Generalised Pareto distribution growth factors
GEVPars

Generalised extreme value distribution parameter estimates
GetAM

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

Gumbel distribution growth factors
GetRainSEPA

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

Goodness of fit comparison (for a pooling group)
GetRainEA

Get Environment Agency rainfall data (England).
GenLogPars

Generalised logistic distribution parameter estimates
Kappa3Est

Kappa3 distribution estimates from parameters
Kappa3GF

Kappa3 distribution growth factors
GenLogGF

Generalised logistic distribution growth factors
LRatioChange

Adjust L-Ratios in a pooling group
GumbelAM

Gumbel distribution - estimates directly from sample
GenParetoPars

Generalised Pareto distribution parameter estimates
GridRefConvert

Convert between British National Grid Reference (BNG) and Latitude and Longitude.
Kappa3Pars

Kappa3 distribution parameter estimates
GumbelPars

Gumbel distribution parameter estimates
LcvUrb

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

Kappa3 distribution - estimates directly from sample
LKurt

Linear Kurtosis (LKurt)
HydroPlot

Hydrological plot of concurrent discharge and precipitation
Lmoms

Lmoments & Lmoment ratios
QMED

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

Monthly Statistics
PoolSmall

Create pooling group for small catchments
QMEDLink

QMED Linking equation
QMEDPOT

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

British national grid reference (NGR) distances
LSkew

Linear Skewness (LSkew)
GetFlowStage_EA

Get flow or level data from the Environment Agency's Hydrology Data Explorer
NRFAData

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

Seasonal correction factor (SCF)
QMEDDonEq

QMED donor adjustment
NonFloodAdj

Non-flood adjustment
QMEDData

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

Urban adjustment for the linear skewness (LSkew)
GetMetOffice

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

Data simulator
WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)
WeightsGLSkew

Site gauged linear skewness (LSkew) weightings
UncSS

Uncertainty for the single site
QuickResults

Quick pooled results
WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings
Rating

Stage-Discharge equation optimisation
UKOutline

UK outline
H2

Heterogeneity measure (H2) for pooling groups.
WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings
ReFH

Revitalised Flood Hydrograph Model (ReFH)
QMEDfseSS

QMED factorial standard error for gauged sites
Lcv

Linear coefficient of variation (Lcv)
WGaugLSkew

Gauged pool weighted linear skewness (LSkew)
Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates
NonFloodAdjPool

Non-flood adjustment for pooling groups
POTextract

Peaks over threshold (POT) data extraction
OptimPars

Optimise distribution parameters
Pool

Create pooling group
PoolEst

Pooled flood estimates
ThamesPQ

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

Trend hypothesis test
POTt

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

Site ungauged linear coefficient of variation (Lcv) weightings
UAF

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

Urban expansion factor
Zdists

Zdist Goodness of fit measure for pooling groups
WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)
WungLSkew

Ungauged pool weighted linear skewness (LSkew)
CDsXML

Import catchment descriptors from .xml files
AMextract

Annual maximum extraction
AddGauge

Add an AMAX sample
AMplot

Plot of the annual maximum sample
ARF

Areal reduction factor (ARF)
AMImport

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

Aggregate a time series
DDF99

FEH99 depth duration frequency precipitation model
AMSP

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

Donor adjustment candidates & results
DDFImport

DDF13 or DDF22 results from .xml files
DeTrend

Linearly detrend a sample
BFI

Baseflow index (BFI)
DDF

DDF results from a DDFImport object
EVPlot

Extreme value plot (frequency and growth curves)
EVPlotAdd

Add lines and/or points to an extreme value plot