predict.amax: Predict return levels

In martindurocher/floodStat: FloodNet Regional Frequency Analysis

Description

Return the flood quantile of annual maximum distribution and Confident intervals are provided by bootstrap.

Usage

## S3 method for class 'amax'
predict(obj, q = c(0.5, 0.8, 0.9, 0.95, 0.98, 0.99),
  se = FALSE, ci = "none", alpha = 0.05, nsim = 1000,
  out.matrix = FALSE)

Arguments

obj	Output from FitAmax
q	Probabilities associated to the return level. For example, a 100 years return period is equivalent to q = 0.99.
se	Return the standard deviation of the return level using the delta method. The fitted model must
ci	Method to compute the confident interval. One of 'delta' for the delta method, 'boot' for parametric boostrap and 'norm' for Monte-Carlo approximation assuming normality of the parameters.
alpha	Probability outside the confident interval.
nsim	Number of simulation use for resampling.
out.matrix	Logical. Should the resampling be returned. If true, a list is returned containing the prediction table (pred), the parameters (para) and the return levels (qua).

Examples

#' ## Extract an time series of annual maxima
x <- ExtractAmax(flow~date, flowStJohn)$flow

## Fitting of GEV distribution using L-moments
fit <- FitAmax(x,'gev', method = 'mle')

## Get the estimated quantile of 10 and 100 years return period
rp <- 1-1/c(10,100)
predict(fit, rp)
predict(fit, se = TRUE, ci = 'delta')

## The bootstrap sample used for CI are returned
fit <- FitAmax(x,'gev', varcov = FALSE)
boot <- predict(fit, rp, se = FALSE, ci = 'boot',
                nsim = 500, out.matrix = TRUE)

martindurocher/floodStat documentation built on May 31, 2019, 12:42 a.m.