makeAnnualStat: Compute annual statistic of a variable

In RCMIP5: Tools for Manipulating and Summarizing CMIP5 Data

Description

Most CMIP5 data are monthly, and we frequently want to summarize these to annual numbers. This function does that (although annual files also occur, and will be handled as well). The default statistic is mean, but any summary function that returns a numeric result can be used.

Usage

makeAnnualStat(x, verbose = FALSE, sortData = FALSE, filterNum = TRUE,
  FUN = mean, ...)

Arguments

x	A cmip5data object
verbose	logical. Print info as we go?
sortData	logical. Sort x and area before computing?
filterNum	logical. Only keep the years which share the most common count. For example, only keep years with 12 months and discard those with 11 or fewer.
FUN	function. Function to apply across months of year
...	Other arguments passed on to FUN

Details

The stat function is calculated for all combinations of lon, lat, and Z (if present).

Value

A cmip5data object, whose val field is the annual mean of the variable. A numMonths field is also added recording the number of months averaged for each year.

Note

If x is not in a needed order (for example, FUN uses weights in a different order), be sure to specify sortData=TRUE.

See Also

makeZStat makeGlobalStat makeMonthlyStat

Examples

d <- cmip5data(1970:1975)   # sample data
makeAnnualStat(d)
summary(makeAnnualStat(d))
summary(makeAnnualStat(d, FUN=sd))

RCMIP5 documentation built on May 1, 2019, 6:28 p.m.