GenParetoPOT: Generalised Pareto distribution - estimates directly from...

View source: R/All.R

GenParetoPOTR Documentation

Generalised Pareto distribution - estimates directly from sample

Description

Estimated quantiles as function of return period (RP) and vice versa, directly from the data

Usage

GenParetoPOT(x, ppy = 1, RP = 100, q = NULL)

Arguments

x

numeric vector (block maxima sample)

ppy

peaks per year

RP

return period (default = 100)

q

quantile (magnitude of variable)

Details

If the argument q is used, it overrides RP and provides RP as a function of q (magnitude of variable) as opposed to q as a function of RP. The average number of peaks per year argument (ppy) is for the function to convert from the peaks over threshold (POT) scale to the annual scale. For example, if there are 3 peaks per year, the probability associated with the 100-yr return period estimate would be 0.01/3 (i.e. an RP of 300 on the POT scale) rather than 0.01. The parameters are estimated by the method of L-moments, as detailed in 'Hosking J. Wallis J. 1997 Regional Frequency Analysis: An Approach Based on L-moments. Cambridge University Press, New York'.

Value

quantile as a function of RP or vice versa

Author(s)

Anthony Hammond

Examples

#Get a POT series and estimate the 50-year RP
ThamesPOT <- POTextract(ThamesPQ[,c(1,3)], thresh = 0.90)
GenParetoPOT(ThamesPOT$peak, ppy = 1.867, RP = 50)
#Estimate the RP for a 600m3/s discharge
GenParetoPOT(ThamesPOT$peak, ppy = 1.867, q = 600)

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

Related to GenParetoPOT in UKFE...