OptimPars: Optimise distribution parameters
In UKFE: UK Flood Estimation

OptimPars

R Documentation

Optimise distribution parameters

Description

Estimates the parameters of the generalised extreme value, generalised logistic, or Gumbel distribution from known return period estimates

Usage

OptimPars(x, dist = "GenLog")

Arguments

`x`	a data.frame with RPs in the first column and associated estimates in the second column
`dist`	a choice of distribution for the estimates. The choices are "GenLog", "GEV", or "Gumbel" - the generalised logistic, generalised extreme value and Gumbel distribution, respectively. The default is "GenLog"

Details

Given a dataframe with return periods (RPs) in the first column and associated estimates in the second column, this function provides an estimate of the distribution parameters. Ideally the first RP should be 2. Extrapolation outside the RPs used for calibration comes with greater uncertainty.

Value

The location, scale and shape parameters for the generalised logistic or Generalised extreme value distribution. Or the location and scale for the Gumbel.

Author(s)

Anthony Hammond

Examples

#Get some catchment descriptors and some quick results. Then estmate the GenLog parameters
Results <- QuickResults(GetCDs(96001), plot = FALSE)[[1]]
OptimPars(Results[,1:2])

UKFE documentation built on Nov. 6, 2023, 1:07 a.m.