man-roxygen/cdd_common.R

#' The \code{spells.can.span.years} option specifies whether spells can cross
#' year boundaries -- i.e., span years. The default for this is the same as for
#' fclimdex.
#' 
#' @param ci Object of type climdexInput.
#' @param spells.can.span.years Whether to allow spells to span years
#' @return A vector containing the length of the spell for each year.
#' @seealso \code{\link{climdexInput.raw}}, \code{\link{climdexInput.csv}},
#' \code{\link{spell.length.max}}.
#' @references \url{http://etccdi.pacificclimate.org/list_27_indices.shtml}
#' @keywords ts climate
pacificclimate/climdex.pcic documentation built on July 30, 2023, 10:59 a.m.