UKFE1.0.1 package

UK Flood Estimation

AddGauge

Add an AMAX sample

AggDayHour

Aggregate a time series

AMImport

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

AMplot

Plot of the annual maximum sample

AnnualStat

Annual statistics extraction

ARF

Areal reduction factor (ARF)

BFI

Baseflow index (BFI)

Bootstrap

Bootstrap

CDsXML

Import catchment descriptors from .xml files

ConvertGridRef

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

DDF

DDF results from a DDFImport object

DDF99

FEH99 depth duration frequency precipitation model

DDF99Pars

DDF99 parameters from .xml files

DDFExtract

Derive and plot rainfall Depth Duration Frequency curves.

DDFImport

DDF13 or DDF22 results from .xml files

DesHydro

Design hydrograph extraction

DeTrend

Linearly detrend a sample

DiagPlots

Diagnostic plots for pooling groups

DonAdj

Donor adjustment candidates & results

EncProb

Encounter probabilities

ERPlot

Extreme rank plot

EVPlot

Extreme value plot (frequency and growth curves)

EVPlotAdd

Add lines and/or points to an extreme value plot

EVPool

Extreme value plot for pooling groups

FlowDurationCurve

Flow duration curve

FlowSplit

Flow splitter

GenLogAM

Generalised logistic distribution - estimates directly from sample

GenLogEst

Generalised logistic distribution estimates from parameters

GenLogGF

Generalised logistic distribution growth factors

GenLogPars

Generalised logistic distribution parameter estimates

GenParetoEst

Generalised Pareto distribution estimates from parameters

GenParetoGF

Generalised Pareto distribution growth factors

GenParetoPars

Generalised Pareto distribution parameter estimates

GenParetoPOT

Generalised Pareto distribution - estimates directly from sample

GetAM

Get an annual maximum sample from the National River Flow Archive site...

GetCDs

Get catchment descriptors from the National River Flow Archive sites c...

GetDataEA_QH

Get flow or level data from the Environment Agency's Hydrology Data Ex...

GetDataEA_Rain

Get Environment Agency rainfall data (England).

GetDataMetOffice

Get regional Met Office average temperature or rainfall series (monthl...

GetDataNRFA

Get National River Flow Archive data using gauge ID.

GetDataSEPA_QH

Get flow or level data from the Scottish Environmental Protection Agen...

GetDataSEPA_Rain

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

GetQMED

QMED from a gauged site suitable for QMED

GEVAM

Generalised extreme value distribution - estimates directly from sampl...

GEVEst

Generalised extreme value distribution estimates from parameters

GEVGF

Generalised extreme value distribution growth factors

GEVPars

Generalised extreme value distribution parameter estimates

GoFCompare

Goodness of fit comparison (single sample)

GoFComparePool

Goodness of fit comparison (for a pooling group)

GumbelAM

Gumbel distribution - estimates directly from sample

GumbelEst

Gumbel distribution estimates from parameters

GumbelGF

Gumbel distribution growth factors

GumbelPars

Gumbel distribution parameter estimates

H2

Heterogeneity measure (H2) for pooling groups.

HydroPlot

Hydrological plot of concurrent discharge and precipitation

Kappa3AM

Kappa3 distribution - estimates directly from sample

Kappa3Est

Kappa3 distribution estimates from parameters

Kappa3GF

Kappa3 distribution growth factors

Kappa3Pars

Kappa3 distribution parameter estimates

Lcv

Linear coefficient of variation (Lcv)

LcvUrb

Urban adjustment for the linear coefficient of variation (Lcv)

LKurt

Linear Kurtosis (LKurt)

LMoments

Lmoments & Lmoment ratios

LRatioChange

Adjust L-Ratios in a pooling group

LSkew

Linear Skewness (LSkew)

LSkewUrb

Urban adjustment for the linear skewness (LSkew)

MonthlyStats

Monthly Statistics

NGRDist

British national grid reference (NGR) distances

NonFloodAdj

Non-flood adjustment

NonFloodAdjPool

Non-flood adjustment for pooling groups

OptimPars

Optimise distribution parameters

Pool

Create pooling group

PoolEst

Pooled flood estimates

PoolSmall

Create pooling group for small catchments

POTextract

Peaks over threshold (POT) data extraction

POTt

Peaks over threshold (POT) data extraction (quick)

QMED

QMED (median annual maximum flow) estimate from catchment descriptors

QMEDDonEq

QMED donor adjustment

QMEDfseSS

QMED factorial standard error for gauged sites

QMEDLink

QMED Linking equation

QMEDPOT

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

QuickResults

Quick pooled results

Rating

Stage-Discharge equation optimisation

ReFH

Revitalised Flood Hydrograph Model (ReFH)

SCF

Seasonal correction factor (SCF)

SimData

Data simulator

TrendTest

Trend hypothesis test

UAF

Urban adjustment factor (UAF) and percentage runoff urban adjustment f...

UEF

Urban expansion factor

Uncertainty

Uncertainty quantification for gauged and ungauged pooled estimates

WeightsGLcv

Site gauged linear coefficient of variation (Lcv) weightings

WeightsGLSkew

Site gauged linear skewness (LSkew) weightings

WeightsUnLcv

Site ungauged linear coefficient of variation (Lcv) weightings

WeightsUnLSkew

Site ungauged linear skewness (LSkew) weightings

WGaugLcv

Gauged pool weighted linear coefficient of variation (Lcv)

WGaugLSkew

Gauged pool weighted linear skewness (LSkew)

WungLcv

Ungauged pool weighted linear coefficient of variation (Lcv)

WungLSkew

Ungauged pool weighted linear skewness (LSkew)

Zdists

Zdist Goodness of fit measure for pooling groups

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, <doi:10.2166/nh.2019.157>). "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, <doi:10.2166/nh.2021.059>). "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, <http://software.hydrosolutions.co.uk/winfap4/Urban-Adjustment-Procedure-Technical-Note.pdf>). Data from the UK National River Flow Archive (<https://nrfa.ceh.ac.uk/>, terms and conditions: <https://nrfa.ceh.ac.uk/help/costs-terms-and-conditions>).

  • Maintainer: Anthony Hammond
  • License: GPL-3
  • Last published: 2025-10-08