# UK Flood Estimation

## Documentation for package ‘UKFE’ version 1.0.1

- DESCRIPTION file.
- User guides, package vignettes and other documentation.
- Package NEWS.

## Help Pages

A B C D E F G H K L M N O P Q R S T U W Z

## -- A --

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
AMSP | National River Flow Archive (NRFA) annual maximum data for sites suitable for pooling
AnnualStat | Annual statistics extraction
ARF | Areal reduction factor (ARF)

## -- B --

BFI | Baseflow index (BFI)
Bootstrap | Bootstrap

## -- C --

CDsXML | Import catchment descriptors from .xml files
ConvertGridRef | Convert between British National Grid Reference (BNG) and Latitude and Longitude or Irish Grid references.

## -- D --

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

## -- E --

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

## -- F --

FlowDurationCurve | Flow duration curve
FlowSplit | Flow splitter

## -- G --

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_QH | Get flow or level data from the Scottish Environmental Protection Agency.
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 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

## -- H --

H2 | Heterogeneity measure (H2) for pooling groups.
HydroPlot | Hydrological plot of concurrent discharge and precipitation

## -- K --

Kappa3AM | Kappa3 distribution - estimates directly from sample
Kappa3Est | Kappa3 distribution estimates from parameters
Kappa3GF | Kappa3 distribution growth factors
Kappa3Pars | Kappa3 distribution parameter estimates

## -- L --

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)

## -- M --

MonthlyStats | Monthly Statistics

## -- N --

NGRDist | British national grid reference (NGR) distances
NonFloodAdj | Non-flood adjustment
NonFloodAdjPool | Non-flood adjustment for pooling groups
NRFAData | National River Flow Archive descriptors and calculated statistics for sites suitable for pooling

## -- O --

OptimPars | Optimise distribution parameters

## -- P --

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)

## -- Q --

QMED | QMED (median annual maximum flow) estimate from catchment descriptors
QMEDData | National River Flow Archive descriptors and calculated statistics for sites suitable for QMED & pooling
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

## -- R --

Rating | Stage-Discharge equation optimisation
ReFH | Revitalised Flood Hydrograph Model (ReFH)

## -- S --

SCF | Seasonal correction factor (SCF)
SimData | Data simulator

## -- T --

ThamesPQ | Kingston upon Thames daily flow and catchment precipitation 2000-10-01 to 2015-09-30
TrendTest | Trend hypothesis test

## -- U --

UAF | Urban adjustment factor (UAF) and percentage runoff urban adjustment factor (PRUAF)
UEF | Urban expansion factor
UKOutline | UK outline
Uncertainty | Uncertainty quantification for gauged and ungauged pooled estimates

## -- W --

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)

## -- Z --

Zdists | Zdist Goodness of fit measure for pooling groups