UK Flood Estimation


[Up] [Top]

Documentation for package ‘UKFE’ version 2.0.0

Help Pages

AddGauge Add an AMAX sample
AggDayHour Aggregate a time series
AMImport Import an annual maximum (AMAX) sample from NRFA peak flow .am files
AMPF National River Flow Archive (NRFA) annual maximum peak flow data for sites suitable for QMED only, and those for pooling.
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
CDsXML_Legacy Import catchment descriptors from older .xml files
ConvertGridRef Convert between British National Grid Reference (BNG) and Latitude and Longitude or Irish Grid references.
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
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 sites suitable for pooling
GetCDs Get catchment descriptors from the National River Flow Archive sites considered suitable for median annual maximum flow estimation (QMED) and pooling.
GetDataEA_QH Get flow or level data from the Environment Agency's Hydrology Data Explorer
GetDataEA_Rain Get Environment Agency rainfall data (England).
GetDataMetOffice Get regional Met Office average temperature or rainfall series (monthly, seasonal, and annual).
GetDataNRFA Get National River Flow Archive data using gauge ID.
GetDataSEPA Get Scottish Environment Protection Agency (SEPA) Flow, Level, or Rainfall data.
GetQMED QMED from a gauged site suitable for QMED
GEVAM Generalised extreme value distribution - estimates directly from sample
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.
HistoricMLE Historic flood maximum likelihood estimation
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
LowFlows Low Flows
LRatioChange Adjust L-Ratios in a pooling group
LSkew 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
PeakFlowData National River Flow Archive descriptors and calculated statistics for sites suitable for QMED & pooling
Pool Create pooling group
PoolEst Pooled flood estimates
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)
Seasonality Seasonality plot
SimData Data simulator
ThamesPQ Kingston upon Thames daily flow and catchment precipitation 2000-10-01 to 2015-09-30
TrendTest Trend hypothesis test
UAF Urban adjustment factor (UAF)
UEF Urban expansion factor
UKOutline UK outline
Uncertainty Uncertainty quantification for gauged and ungauged pooled estimates
WeightedMoments Weighted Lmoment ratios (LCV and LSKEW) from a pooling group
WeightsLCV Linear coefficient of variation (Lcv) weightings for a pooling group
WeightsLSKEW Linear Skewness (LSKEW) weightings for a pooling group
Zdists Zdist Goodness of fit measure for pooling groups