Package index • UKFE

Stats functions

Functions for carrying out statistical distribution fitting.

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

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

GumbelAM(): Gumbel distribution - estimates directly from sample

GumbelEst(): Gumbel distribution estimates from parameters

GumbelGF(): Gumbel distribution growth factors

GumbelPars(): Gumbel distribution parameter estimates

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

LSkew(): Linear Skewness (LSkew)

OptimPars(): Optimise distribution parameters

HistoricMLE(): Historic flood maximum likelihood estimation

QMED functions

Functions relating to estimation of QMED (the median annual maximum flow).

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

QMED_FEH08(): QMED (median annual maximum flow) estimate from catchment descriptors using the FEH 2008 method.

DonAdj(): Donor adjustment candidates

Pooling group functions

Functions relating to the creation and use of pooling groups.

Pool(): Create pooling group

PoolEst(): Pooled flood estimates

PoolEst_FEH08(): Pooled flood estimates using the FEH2008 method

Pool_FEH08(): Create pooling group using the FEH08 method

AddGauge(): Add an AMAX sample

WeightsLCV(): Linear coefficient of variation (Lcv) weightings for a pooling group

WeightsLSKEW(): Linear Skewness (LSKEW) weightings for a pooling group

LRatioChange(): Adjust L-Ratios in a pooling group

WeightedMoments(): Weighted Lmoment ratios (LCV and LSKEW) from a pooling group

Uncertainty(): Uncertainty quantification for gauged and ungauged pooled estimates

QuickResults(): Quick pooled results

Get data functions

Functions for retrieving, importing or viewing data.

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

AMImport(): Import an annual maximum (AMAX) sample from NRFA peak flow .am files

CDsXML(): Import catchment descriptors from .xml files

CDsXML_Legacy(): Import catchment descriptors from older .xml files

Datasets

Datasets saved within the package.

AMPF: National River Flow Archive (NRFA) annual maximum peak flow data for sites suitable for QMED only, and those for pooling.

PeakFlowData: National River Flow Archive descriptors and calculated statistics for sites suitable for QMED & pooling

ThamesPQ: Kingston upon Thames daily flow and catchment precipitation 2000-10-01 to 2015-09-30

UKOutline: UK outline

Diagnostic functions

Functions for obtaining diagnostics.

GoFCompare(): Goodness of fit comparison (single sample)

GoFComparePool(): Goodness of fit comparison (for a pooling group)

H2(): Heterogeneity measure (H2) for pooling groups.

Zdists(): Zdist Goodness of fit measure for pooling groups

DiagPlots(): Diagnostic plots for pooling groups

AMplot(): Plot of the annual maximum sample

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

Seasonality(): Seasonality plot

Rainfall functions

Functions relating to depth duration frequency data.

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

Other time series functions

Functions for working with time series data (e.g. aggregating and detrending data).

AggMonDayHour(): Aggregate a time series

AnnualStat(): Annual statistics extraction

DeTrend(): Linearly detrend a sample

MonthlyStats(): Monthly Statistics

POTextract(): Peaks over threshold (POT) data extraction

POTt(): Peaks over threshold (POT) data extraction (quick)

TrendTest(): Trend hypothesis test

Other hydrological functions

Functions that are not directly used for FEH analysis but may be useful for other hydrological analysis.

ARF(): Areal reduction factor (ARF)

BFI(): Baseflow index (BFI)

DesHydro(): Design hydrograph extraction

FlowDurationCurve(): Flow duration curve

FlowSplit(): Flow splitter

HydroPlot(): Hydrological plot of concurrent discharge and precipitation

Rating(): Stage-Discharge equation optimisation

ReFH(): Revitalised Flood Hydrograph Model (ReFH)

SCF(): Seasonal correction factor (SCF)

UAF(): Urban adjustment factor (UAF)

UEF(): Urban expansion factor

LowFlows(): Low Flows

Other

Bootstrap(): Bootstrap

ConvertGridRef(): Convert between British National Grid Reference (BNG) and Latitude and Longitude or Irish Grid references.

EncProb(): Encounter probabilities

NGRDist(): British national grid reference (NGR) distances

NonFloodAdj(): Non-flood adjustment

NonFloodAdjPool(): Non-flood adjustment for pooling groups

SimData(): Data simulator