index.annual.cycle: Annual cycle statistics

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

index.annual.cycleR Documentation

Annual cycle statistics

Description

Computes several annual cycle statistics

Usage

index.annual.cycle(
  ts,
  dates,
  type = c("phase", "min", "max", "amp", "relamp", "asymmetry"),
  window.width = 61
)

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

Character string indicating the statistic. Currently implemented options are "min", "max", "amp" for amplitude, "relamp" for relative amplitude (in %), "phase" for amplitude of the filtered time series and "asymmetry" to calculate the difference in days between maximum and minimum of the filtered cycle (see Details for the last two types).

window.width

Integer number indicating the width, in days, of the window used for moving average computation of the reference daily climatology. Default to 61 days. See details.

Details

Time series filter

A (circular) moving average daily climatology is calculated for each data series, considering a user-defined window width centered around lag 0.

Value

A float number with the corresponding statistics.

Author(s)

Sven Kotlarski, S. Herrera, J. Bedia, D. San Martin, D. Maraun


SantanderMetGroup/VALUE documentation built on July 8, 2023, 7:03 a.m.