climdex.get.available.indices: Get available indices by name

Description Usage Arguments Details Value Examples

View source: R/climdex.r

Description

This function returns a vector of (function) names of available indices.

Usage

1
climdex.get.available.indices(ci, function.names = TRUE)

Arguments

ci

Object of type climdexInput.

function.names

Whether to return function names.

Details

This function takes a climdexInput object as input and returns the names of all the indices which may be computed or, if get.function.names is TRUE (the default), the names of the functions corresponding to the indices.

Value

A vector containing an annual timeseries of precipitation in wet days.

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))

## Get list of functions which might be run.
func.names <- climdex.get.available.indices(ci)

Example output

Loading required package: PCICt

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