Man pages for UKFE
UK Flood Estimation

AddGaugeAdd an AMAX sample
AggDayHourAggregate a time series
AMImportImport an annual maximum (AMAX) sample from NRFA peak flow...
AMPFNational River Flow Archive (NRFA) annual maximum peak flow...
AMplotPlot of the annual maximum sample
AnnualStatAnnual statistics extraction
ARFAreal reduction factor (ARF)
BFIBaseflow index (BFI)
BootstrapBootstrap
CDsXMLImport catchment descriptors from .xml files
CDsXML_LegacyImport catchment descriptors from older .xml files
ConvertGridRefConvert between British National Grid Reference (BNG) and...
DDFDDF results from a DDFImport object
DDF99FEH99 depth duration frequency precipitation model
DDF99ParsDDF99 parameters from .xml files
DDFExtractDerive and plot rainfall Depth Duration Frequency curves.
DDFImportDDF13 or DDF22 results from .xml files
DesHydroDesign hydrograph extraction
DeTrendLinearly detrend a sample
DiagPlotsDiagnostic plots for pooling groups
DonAdjDonor adjustment candidates
EncProbEncounter probabilities
ERPlotExtreme rank plot
EVPlotExtreme value plot (frequency and growth curves)
EVPlotAddAdd lines and/or points to an extreme value plot
EVPoolExtreme value plot for pooling groups
FlowDurationCurveFlow duration curve
FlowSplitFlow splitter
GenLogAMGeneralised logistic distribution - estimates directly from...
GenLogEstGeneralised logistic distribution estimates from parameters
GenLogGFGeneralised logistic distribution growth factors
GenLogParsGeneralised logistic distribution parameter estimates
GenParetoEstGeneralised Pareto distribution estimates from parameters
GenParetoGFGeneralised Pareto distribution growth factors
GenParetoParsGeneralised Pareto distribution parameter estimates
GenParetoPOTGeneralised Pareto distribution - estimates directly from...
GetAMGet an annual maximum sample from the National River Flow...
GetCDsGet catchment descriptors from the National River Flow...
GetDataEA_QHGet flow or level data from the Environment Agency's...
GetDataEA_RainGet Environment Agency rainfall data (England).
GetDataMetOfficeGet regional Met Office average temperature or rainfall...
GetDataNRFAGet National River Flow Archive data using gauge ID.
GetDataSEPAGet Scottish Environment Protection Agency (SEPA) Flow,...
GetQMEDQMED from a gauged site suitable for QMED
GEVAMGeneralised extreme value distribution - estimates directly...
GEVEstGeneralised extreme value distribution estimates from...
GEVGFGeneralised extreme value distribution growth factors
GEVParsGeneralised extreme value distribution parameter estimates
GoFCompareGoodness of fit comparison (single sample)
GoFComparePoolGoodness of fit comparison (for a pooling group)
GumbelAMGumbel distribution - estimates directly from sample
GumbelEstGumbel distribution estimates from parameters
GumbelGFGumbel distribution growth factors
GumbelParsGumbel distribution parameter estimates
H2Heterogeneity measure (H2) for pooling groups.
HistoricMLEHistoric flood maximum likelihood estimation
HydroPlotHydrological plot of concurrent discharge and precipitation
Kappa3AMKappa3 distribution - estimates directly from sample
Kappa3EstKappa3 distribution estimates from parameters
Kappa3GFKappa3 distribution growth factors
Kappa3ParsKappa3 distribution parameter estimates
LcvLinear coefficient of variation (Lcv)
LcvUrbUrban adjustment for the linear coefficient of variation...
LKurtLinear Kurtosis (LKurt)
LMomentsLmoments & Lmoment ratios
LowFlowsLow Flows
LRatioChangeAdjust L-Ratios in a pooling group
LSkewLinear Skewness (LSkew)
MonthlyStatsMonthly Statistics
NGRDistBritish national grid reference (NGR) distances
NonFloodAdjNon-flood adjustment
NonFloodAdjPoolNon-flood adjustment for pooling groups
OptimParsOptimise distribution parameters
PeakFlowDataNational River Flow Archive descriptors and calculated...
PoolCreate pooling group
PoolEstPooled flood estimates
POTextractPeaks over threshold (POT) data extraction
POTtPeaks over threshold (POT) data extraction (quick)
QMEDQMED (median annual maximum flow) estimate from catchment...
QMEDDonEqQMED donor adjustment
QMEDfseSSQMED factorial standard error for gauged sites
QMEDLinkQMED Linking equation
QMEDPOTEmpirical estimate of QMED from peaks over threshold (POT)...
QuickResultsQuick pooled results
RatingStage-Discharge equation optimisation
ReFHRevitalised Flood Hydrograph Model (ReFH)
SCFSeasonal correction factor (SCF)
SeasonalitySeasonality plot
SimDataData simulator
ThamesPQKingston upon Thames daily flow and catchment precipitation...
TrendTestTrend hypothesis test
UAFUrban adjustment factor (UAF)
UEFUrban expansion factor
UKOutlineUK outline
UncertaintyUncertainty quantification for gauged and ungauged pooled...
WeightedMomentsWeighted Lmoment ratios (LCV and LSKEW) from a pooling group
WeightsLCVLinear coefficient of variation (Lcv) weightings for a...
WeightsLSKEWLinear Skewness (LSKEW) weightings for a pooling group
ZdistsZdist Goodness of fit measure for pooling groups
UKFE documentation built on Nov. 5, 2025, 6:25 p.m.