Skip to contents

Extracts the exceedances from a pgpTList object. The typical use of the result is in a ggplot showing the temporal evolution of the number of exceedances. The annual number of exceedances can be plotted along with the rate of a time-varying Poisson process inasmuch this rate is expressed in inverse year \(\textrm{yr}^{-1}\).

Usage

# S3 method for pgpTList
exceed(object, byYear = TRUE, ...)

Arguments

object

The object from which the exceedances are to be exctraced..

byYear

Logical. If TRUE, the exceedances are summarised as a number by year.

...

Not used.

Value

A data frame in "long format" row-binding timeseries relative to the exceedances for each of the thresholds used in

object.

Details

Even when byYear is TRUE, the returned data frame has a Date column that can be used in plots.