index.rv: Return Value

View source: R/index.rv.R

index.rvR Documentation

Return Value

Description

Function to compute return values

Usage

index.rv(ts, prob = 20, annual.index = TRUE, tail)

Arguments

ts

A vector containing the data

prob

Return period considered (in years). Default to 20.

annual.index

Logical. If set to TRUE, a vector defining the years for aggregation is passed by wrapperFUN. Otherwise no temporal aggregation of the input time series is performed.

tail

A character indicating wheter GEV is being fit for maxima (tail="right") or minima (tail="left").

Value

Return value

Author(s)

Neyko Neykov, S. Herrera, J. Bedia


SantanderMetGroup/R_VALUE documentation built on July 4, 2023, 4:27 a.m.