Return Periods for a potData Object — RP.potData • potomax

Return Periods for a potData object.

Usage

# S3 method for potData
RP(object, points = c("p", "H"), a = 0.5, ...)

Arguments

object: A potData object, usually created by using potData or by coercing an object of class "Rendata".
points: Type of plotting positions to use: ppoints or code Nelson's positions.
a: Passed to ppoints when the value points is "p". Ignored else.
...: Not used yet.

Value

A list with several elements. The element data is a data frame which contains so-called plotting positions

as required to display the observations as points on en empirical return level plot. The columns of data

include T giving the return period in years, S

giving the survival or probability of exceedance and x

return level. The columns OT and source keep trace of the blocks from which the observation was extracted.

Details

This is a refactoring of the SandT function of the Renext package.

References

Chap. 4 in Yves Deville(2020) Renext Computing Details. Tech. Report.

Examples

pdat <- potData(data = Garonne$OTdata$Flow,
                effDuration = 65,
                MAX.data = Garonne$MAXdata$Flow,
                MAX.effDuration = 143)
L <- RP(pdat)

Return Periods for a `potData` Object