index.annual.cycle.filtered: Filtered annual cycle maxima statistics

View source: R/index.annual.cycle.filtered.R

index.annual.cycle.filteredR Documentation

Filtered annual cycle maxima statistics

Description

Returns the amplitude or the location of the maxima of the annual cycle

Usage

index.annual.cycle.filtered(ts, dates, type = "phase", peak = 1,
  thresh = 0.1)

Arguments

ts

A vector containing the data

dates

A character (or POSIXct) vector following the format “YYYY-MM-DD” (i.e., format = "%Y-%m-%d" as in strptime). This is directly passed by the VALUE objects (either stations or predictions) through the element object$Dates$start.

type

A character string indicating max "phase" (days, default), "amp" (amplitude) or "amprel" (relative amplitude)

peak

= 1 or 2 (maximum or secondary maximum - higher order peaks are ignored)

thresh

Threshold that defines weak and double maxima (relative to amplitude of annual cycle)

Value

A float number corresponding to the amplitude or the (phase) day of the maxima

Author(s)

D. Maraun, J. Bedia, D. San-Martin, J.M. Gutierrez


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