Package: UKFE 2.0.1

UKFE: UK Flood Estimation

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 14. 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). "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>). "The FEH 2025 statistical method update", UK Centre for Ecology and Hydrology (2025). "Low flow estimation in the United Kingdom", Institute of Hydrology (1992, ISBN 0 948540 45 1). 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>).

Authors:Anthony Hammond [aut, cre]

UKFE_2.0.1.tar.gz
UKFE_2.0.1.zip(r-4.7)UKFE_2.0.1.zip(r-4.6)UKFE_2.0.1.zip(r-4.5)
UKFE_2.0.1.tgz(r-4.6-any)UKFE_2.0.1.tgz(r-4.5-any)
UKFE_2.0.1.tar.gz(r-4.7-any)UKFE_2.0.1.tar.gz(r-4.6-any)
UKFE_2.0.1.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
card.svg |card.png
UKFE/json (API)
NEWS

# Install 'UKFE' in R:
install.packages('UKFE', repos = c('https://agqhammond.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/agqhammond/ukfe/issues

Pkgdown/docs site:https://agqhammond.github.io

Datasets:
  • ThamesPQ - Kingston upon Thames daily flow and catchment precipitation 2000-10-01 to 2015-09-30
  • UKOutline - UK outline

On CRAN:

Conda:

2.78 score 12 scripts 399 downloads 97 exports 15 dependencies

Last updated from:a5dded37c3. Checks:7 ERROR, 2 OK. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64ERROR141
source / vignettesOK159
linux-release-x86_64ERROR133
macos-release-arm64ERROR152
macos-oldrel-arm64ERROR144
windows-develERROR121
windows-releaseERROR146
windows-oldrelERROR101
wasm-releaseOK110

Exports:AddGaugeAggMonDayHourAMImportAMplotAnnualStatARFBFIBootstrapCDsXMLCDsXML_LegacyConvertGridRefDDFDDF99DDF99ParsDDFExtractDDFImportDesHydroDeTrendDiagPlotsDonAdjEncProbERPlotEVPlotEVPlotAddEVPoolFlowDurationCurveFlowSplitGenLogAMGenLogEstGenLogGFGenLogParsGenParetoEstGenParetoGFGenParetoParsGenParetoPOTGetAMGetCDsGetDataEA_QHGetDataEA_RainGetDataMetOfficeGetDataNRFAGetDataSEPAGetQMEDGEVAMGEVEstGEVGFGEVParsGoFCompareGoFComparePoolGumbelAMGumbelEstGumbelGFGumbelParsH2HistoricMLEHydroPlotKappa3AMKappa3EstKappa3GFKappa3ParsLcvLcvUrbLKurtLMomentsLowFlowsLRatioChangeLSkewMonthlyStatsNGRDistNonFloodAdjNonFloodAdjPoolOptimParsPoolPool_FEH08PoolEstPoolEst_FEH08POTextractPOTtQMEDQMED_FEH08QMEDDonEqQMEDfseSSQMEDLinkQuickResultsRatingReFHSCFSeasonalitySimDataTrendTestUAFUEFUncertaintyWeightedMomentsWeightsLCVWeightsLSKEWZdists

Dependencies:classclassIntcliDBIe1071KernSmoothMASSproxyRcpprlangs2sfunitswkxml2

Readme and manuals

Help Manual

Help pageTopics
Add an AMAX sampleAddGauge
Aggregate a time seriesAggMonDayHour
Import an annual maximum (AMAX) sample from NRFA peak flow .am filesAMImport
National River Flow Archive (NRFA) annual maximum peak flow data for sites suitable for QMED only, and those for pooling.AMPF
Plot of the annual maximum sampleAMplot
Annual statistics extractionAnnualStat
Areal reduction factor (ARF)ARF
Baseflow index (BFI)BFI
BootstrapBootstrap
Import catchment descriptors from .xml filesCDsXML
Import catchment descriptors from older .xml filesCDsXML_Legacy
Convert between British National Grid Reference (BNG) and Latitude and Longitude or Irish Grid references.ConvertGridRef
DDF results from a DDFImport objectDDF
FEH99 depth duration frequency precipitation modelDDF99
DDF99 parameters from .xml filesDDF99Pars
Derive and plot rainfall Depth Duration Frequency curves.DDFExtract
DDF13 or DDF22 results from .xml filesDDFImport
Design hydrograph extractionDesHydro
Linearly detrend a sampleDeTrend
Diagnostic plots for pooling groupsDiagPlots
Donor adjustment candidatesDonAdj
Encounter probabilitiesEncProb
Extreme rank plotERPlot
Extreme value plot (frequency and growth curves)EVPlot
Add lines and/or points to an extreme value plotEVPlotAdd
Extreme value plot for pooling groupsEVPool
Flow duration curveFlowDurationCurve
Flow splitterFlowSplit
Generalised logistic distribution - estimates directly from sampleGenLogAM
Generalised logistic distribution estimates from parametersGenLogEst
Generalised logistic distribution growth factorsGenLogGF
Generalised logistic distribution parameter estimatesGenLogPars
Generalised Pareto distribution estimates from parametersGenParetoEst
Generalised Pareto distribution growth factorsGenParetoGF
Generalised Pareto distribution parameter estimatesGenParetoPars
Generalised Pareto distribution - estimates directly from sampleGenParetoPOT
Get an annual maximum sample from the National River Flow Archive sites suitable for poolingGetAM
Get catchment descriptors from the National River Flow Archive sites considered suitable for median annual maximum flow estimation (QMED) and pooling.GetCDs
Get flow or level data from the Environment Agency's Hydrology Data ExplorerGetDataEA_QH
Get Environment Agency rainfall data (England).GetDataEA_Rain
Get regional Met Office average temperature or rainfall series (monthly, seasonal, and annual).GetDataMetOffice
Get National River Flow Archive data using gauge ID.GetDataNRFA
Get Scottish Environment Protection Agency (SEPA) Flow, Level, or Rainfall data.GetDataSEPA
QMED from a gauged site suitable for QMEDGetQMED
Generalised extreme value distribution - estimates directly from sampleGEVAM
Generalised extreme value distribution estimates from parametersGEVEst
Generalised extreme value distribution growth factorsGEVGF
Generalised extreme value distribution parameter estimatesGEVPars
Goodness of fit comparison (single sample)GoFCompare
Goodness of fit comparison (for a pooling group)GoFComparePool
Gumbel distribution - estimates directly from sampleGumbelAM
Gumbel distribution estimates from parametersGumbelEst
Gumbel distribution growth factorsGumbelGF
Gumbel distribution parameter estimatesGumbelPars
Heterogeneity measure (H2) for pooling groups.H2
Historic flood maximum likelihood estimationHistoricMLE
Hydrological plot of concurrent discharge and precipitationHydroPlot
Kappa3 distribution - estimates directly from sampleKappa3AM
Kappa3 distribution estimates from parametersKappa3Est
Kappa3 distribution growth factorsKappa3GF
Kappa3 distribution parameter estimatesKappa3Pars
Linear coefficient of variation (Lcv)Lcv
Urban adjustment for the linear coefficient of variation (Lcv)LcvUrb
Linear Kurtosis (LKurt)LKurt
Lmoments & Lmoment ratiosLMoments
Low FlowsLowFlows
Adjust L-Ratios in a pooling groupLRatioChange
Linear Skewness (LSkew)LSkew
Monthly StatisticsMonthlyStats
British national grid reference (NGR) distancesNGRDist
Non-flood adjustmentNonFloodAdj
Non-flood adjustment for pooling groupsNonFloodAdjPool
Optimise distribution parametersOptimPars
National River Flow Archive descriptors and calculated statistics for sites suitable for QMED & poolingPeakFlowData
Create pooling groupPool
Create pooling group using the FEH08 methodPool_FEH08
Pooled flood estimatesPoolEst
Pooled flood estimates using the FEH2008 methodPoolEst_FEH08
Peaks over threshold (POT) data extractionPOTextract
Peaks over threshold (POT) data extraction (quick)POTt
QMED (median annual maximum flow) estimate from catchment descriptorsQMED
QMED (median annual maximum flow) estimate from catchment descriptors using the FEH 2008 method.QMED_FEH08
QMED donor adjustmentQMEDDonEq
QMED factorial standard error for gauged sitesQMEDfseSS
QMED Linking equationQMEDLink
Quick pooled resultsQuickResults
Stage-Discharge equation optimisationRating
Revitalised Flood Hydrograph Model (ReFH)ReFH
Seasonal correction factor (SCF)SCF
Seasonality plotSeasonality
Data simulatorSimData
Kingston upon Thames daily flow and catchment precipitation 2000-10-01 to 2015-09-30ThamesPQ
Trend hypothesis testTrendTest
Urban adjustment factor (UAF)UAF
Urban expansion factorUEF
UK outlineUKOutline
Uncertainty quantification for gauged and ungauged pooled estimatesUncertainty
Weighted Lmoment ratios (LCV and LSKEW) from a pooling groupWeightedMoments
Linear coefficient of variation (Lcv) weightings for a pooling groupWeightsLCV
Linear Skewness (LSKEW) weightings for a pooling groupWeightsLSKEW
Zdist Goodness of fit measure for pooling groupsZdists