RCMIP5 (version 1.2.0)

loadEnsemble: Load a unique CMIP5 ensemble

Description

Loads the data for a particular CMIP5 experiment-variable-model-ensemble combination (one or more files). Returns NULL and a warning if nothing matches.

Usage

loadEnsemble(variable, model, experiment, ensemble, domain, path = ".", recursive = TRUE, verbose = FALSE, force.ncdf = FALSE, yearRange = NULL, ZRange = NULL)

Arguments

variable

CMIP5 variable to load (required)

model

CMIP5 model to load (required)

experiment

CMIP5 experiment to load (required)

ensemble

CMIP5 ensemble to load (required)

domain

optinal CMIP5 domain to load (required)

path

optional root of directory tree

recursive

logical. Recurse into directories?

verbose

logical. Print info as we go?

force.ncdf

[[decrepit]] Force use of the less-desirable ncdf package for testing?

yearRange

numeric of length 2. If supplied, load only these years of data inclusively between these years.

ZRange

numeric of length 2. If supplied, load only Z data within this range.

Value

A cmip5data object, or NULL if nothing loaded

Details

This function is the core of RCMIP5's data-loading. It loads all files matching the experiment, variable, model, ensemble, and domain supplied by the caller.