climdex.rx5day: Monthly Maximum 5-day Consecutive Precipitation

Description Usage Arguments Details Value Note References See Also Examples

View source: R/climdex.r

Description

This function computes the climdex index Rx5day.

Usage

1
2
climdex.rx5day(ci, freq = c("monthly", "annual"),
  center.mean.on.last.day = FALSE)

Arguments

ci

Object of type climdexInput.

freq

Time frequency to aggregate to.

center.mean.on.last.day

Whether to center the 5-day running mean on the last day of the window, instead of the center day.

Details

This function takes a climdexInput object as input and computes the climdex index Rx5day: monthly or annual maximum 5-day consecutive precipitation.

Value

A vector containing the value of the index for each month of each year.

Note

The default behaviour of climdex.rx5day differs somewhat from fclimdex, as fclimdex and climdex.pcic differ on the definition of Rx5day. The running sum series computed by fclimdex is off by 2 days, and the first day a running sum can be computed for is left out entirely. The behaviour of fclimdex can be replicated by setting center.mean.on.last.day to TRUE.

References

http://etccdi.pacificclimate.org/list_27_indices.shtml

See Also

climdexInput.raw, climdexInput.csv.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
library(PCICt)

## Create a climdexInput object from some data already loaded in and
## ready to go.

## Parse the dates into PCICt.
tmax.dates <- as.PCICt(do.call(paste, ec.1018935.tmax[,c("year",
"jday")]), format="%Y %j", cal="gregorian")
tmin.dates <- as.PCICt(do.call(paste, ec.1018935.tmin[,c("year",
"jday")]), format="%Y %j", cal="gregorian")
prec.dates <- as.PCICt(do.call(paste, ec.1018935.prec[,c("year",
"jday")]), format="%Y %j", cal="gregorian")

## Load the data in.
ci <- climdexInput.raw(ec.1018935.tmax$MAX_TEMP,
ec.1018935.tmin$MIN_TEMP, ec.1018935.prec$ONE_DAY_PRECIPITATION,
tmax.dates, tmin.dates, prec.dates, base.range=c(1971, 2000))

## Create a timeseries of monthly maximum 5-day consecutive precipitation.
rx5day <- climdex.rx5day(ci)

Example output

Loading required package: PCICt

climdex.pcic documentation built on March 26, 2020, 7:17 p.m.