rlevd: Return level calculation

In theGreatWhiteShark/climex: Estimating Extreme Events in Climatic Time Series (using Data of the DWD)

Return level calculation

Description

Internal function to calculate the return level of GEV or GP distribution.

Usage

rlevd(period, location = NULL, scale = NULL, shape = NULL,
  threshold = NULL, model = c("gev", "gpd"), silent = FALSE)

Arguments

period	Return period in years.
location	Of the GEV distribution. Default = NULL.
scale	Of the GEV/GP distribution. Default = NULL.
shape	Of the GEV/GP distribution. Default = NULL.
threshold	Used in the GP distribution. This parameter is optional but should be provided in order to create a representation of the fitted data exceedance. Default = NULL.
model	String determining whether to calculate the initial parameters of the GEV ("gev") or GP ("gpd") function. Default = "gev"
silent	Whether to display warnings or not. Default = FALSE.

Details

Port from the extRemes package to ensure compatibility and to make the threshold argument obligatory. This is just for internal usage. Please use the return.level function instead!

Value

Numerical vector of the same length as 'period'.

Author(s)

Philipp Mueller

See Also

Other extremes: block.list, block.xts, block, decluster.list, decluster.xts, decluster, extremal.index, gev.density, gpd.density, qevd, return.level.climex.fit.gev, return.level.climex.fit.gpd, return.level.list, return.level.numeric, return.level, revd, threshold.list, threshold.xts, threshold, upper.limit.climex.fit.gev, upper.limit.climex.fit.gpd, upper.limit.list, upper.limit.numeric, upper.limit

theGreatWhiteShark/climex documentation built on July 13, 2022, 9:11 a.m.