R/family-ecahwfi.R

In rcdo: Wrapper of 'CDO' Operators

## This file was created automatically, do not edit by hand.
#' Warm spell days index wrt 90th percentile of reference period
#'
#' Let infile1 be a time series of the daily mean temperature TG, and infile2 be the 90th percentile TGn90 of daily mean temperatures for any period used as reference. Then counted is the number of days where, in intervals of at least nday consecutive days, TG > TGn90. The number nday is an optional parameter with default nday = 6. A further output variable is the number of warm-spell periods longer than or equal to nday days. TGn90 is calculated as the 90th percentile of daily mean temperatures of a five day window centred on each calendar day of a given climate reference period. Note that both TG and TGn90 have to be given in the same units. Parameter is a comma-separated list of "key=values" pairs. 
#'
#' @details
#'     eca_hwfi     Warm spell days index wrt 90th percentile of reference period
#'                  The operator counts over the entire time series.
#'                  The date information of a timestep in outfile is the date of
#'                  the last contributing timestep in infile.
#'     etccdi_wsdi  Warm Spell Duration Index
#'                  The default output frequency is yearly.
#'                  Periods within overlapping years are accounted for the first year.
#'                  The date information of a timestep in outfile is the mid of
#'                  the frequency interval.
#' 
#'
#' 
#'
#' @returns
#' Operators that output one or more files return a character vector to the
#' output files.
#'
#' Operators that output an indefinite number of files return a string with the
#' basename of the files.
#'
#' Operatos that don't return filenames return a character vector with the
#' string output.
#' @name ecahwfi
NULL