Kappa3Est {UKFE} | R Documentation |
Kappa3 distribution estimates from parameters
Description
Estimated quantiles as function of return period (RP) and vice versa, from user input parameters
Usage
Kappa3Est(loc, scale, shape, q = NULL, RP = 100)
Arguments
loc |
location parameter |
scale |
scale parameter |
shape |
shape parameter |
q |
quantile. magnitude of the variable under consideration |
RP |
return period |
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. This is the Kappa3 distribution as defined in Kjeldsen, T (2019), 'The 3-parameter Kappa distribution as an alternative for use with FEH pooling groups.'Circulation - The Newsletter of the British Hydrological Society, no. 142.
Value
quantile as a function of RP or vice versa
Author(s)
Anthony Hammond
Examples
#Get an annual maximum sample, estimate the parameters and estimate 50-year RP
AM.27090 <- GetAM(27090)
#Get parameters and Store as an object
Pars <- as.numeric(Kappa3Pars(AM.27090$Flow))
#get estimate of 50-yr flow
Kappa3Est(Pars[1], Pars[2], Pars[3], RP = 50)
#Estimate the RP for a 600m3/s discharge
Kappa3Est(Pars[1], Pars[2], Pars[3], q = 600)
[Package UKFE version 0.3.5 Index]