Renext (version 2.0-0)

plot.Renouv: Plot an object of class "Renouv"

Description

Plot an object of class "Renouv". The plot is a return level plot with some supplementary elements to display historical data.

Usage

## S3 method for class 'Renouv':
plot(x,
     pct.conf = NULL,
     show.MAX = TRUE, show.OTS = TRUE,
     mono = TRUE,
     rl.mark = NULL, labels.mark = rl.mark, col.mark = NULL,
     main = NULL,
     problim = NULL,
     Tlim = NULL,
     xlab = "periods",
     ylab = "level",
     \dots)

Arguments

x

Object of class "Renouv".

pct.conf

Percents for confidence limits (lower and upper). These levels should be found within those computed in the object x. By default, all computed levels will be used.

show.MAX

Logical. If TRUE and is x embeds historical data of type MAX, then these will be shown with a symbol differing from the one for ordinary points.

show.OTS

Logical. If TRUE and is x embeds historical data of type OTS, then these will be shown with a symbol differing from the one for ordinary points. An exception is when one or several OTS block have no data.

mono

Logical. For a monochrome plot.

rl.mark

Each return level is materialised with a vertical line.

labels.mark

Label(s) for marked return levels.

col.mark

Color(s) for marked return levels.

main

Main title.

problim

Limits for the x-axis in probability scale.

Tlim

Limits for the x-axis in return period scale. The values are given as a numeric vector of length 2, containing values >=0. The first element (minimal return period can be 0 in which case it will be replaced by a very small positive value.

xlab

Label of the x-axis (log scale).

ylab

Label of the y-axis.

...

Further arguments to be passed to plot e.g. ylim to adjust the y-axis.

Details

The return level plot is of exponential type i.e. uses a log-scale for return periods.

Examples

data(Brest)
fitB <- Renouv(Brest)
plot(fitB, main = "POT fit for Brest data", xlab = "years")
## Garonne example contains historical data.
data(Garonne)
fitG <- Renouv(Garonne)
plot(fitG, main = "POT fit for Garonne data", xlab = "years")
plot(fitG, Tlim = c(1, 2000))