Learn R Programming
⚠️There's a newer version (1.2.0) of this package.Take me there.

RCMIP5: Tools for Manipulating and Summarizing CMIP5 Data

This package provides R functions for exploring, manipulating, and summarizing model outputs from the Coupled Model Intercomparison Project Phase 5 (CMIP5).

Working with CMIP5 data can be tricky, forcing scientists to write custom scripts and programs. The RCMIP5 package aims to ease this process, providing a reproducible, robust, and high-performance set of functions to (i) explore what data have been downloaded, (ii) identify missing data, (iii) average (or apply other mathematical operations) across experimental ensembles, (iv) produce both temporal and spatial statistical summaries, and (v) produce easy-to-work-with graphical and data summaries.

More information about the CMIP5 experiment can be found on the project home page http://cmip-pcmdi.llnl.gov/cmip5/, as well as in Taylor et al. 2012, "An overview of CMIP5 and the experiment design" in Bulletin of the American Meteorological Society 93:485-498, http://dx.doi.org/10.1175/BAMS-D-11-00094.1.

Installing this package

  • The RCMIP5 package can be installed from CRAN or directly from this repository, using the devtools install_github command.

Bugs reports

  • CMIP5 data are highly variable in their structure and assumptions, and there are undoubtedly cases we haven't encountered or anticipated. If you find a bug (something unexpected happens or the code crashes) we want to know about it!
  • Please either open an issue, or email one of the maintainers.
  • In either case, tell us (i) what file(s) you were trying to process, (ii) what sequence of operations led to the problem, and (iii) any other pertinent information.

Other important notes

  • This package does not handle downloading (i.e. from nodes in the Earth System Grid Federation, http://esgf.org) the NetCDF data themselves. Sorry.
  • See http://cmip.llnl.gov/cmip5/publications/allpublications about registering CMIP5 manuscripts.
  • If you use this package/code in your work, please cite it! See citation("RCMIP5").
  • Want to get started? An extensive vignette and demo are included with the package.

Copy Link

Version

Install

install.packages('RCMIP5')

Monthly Downloads

7

Version

1.1

License

MIT + file LICENSE

Maintainer

Kathe ToddBrown

Last Published

November 24th, 2014

Functions in RCMIP5 (1.1)

makeMonthlyStat

Compute monthly statistic of a variable
checkTimePeriod

Check for continuous time periods in CMIP5 files
filterDimensionLat

Filter latitude dimension.
cmip5data

The 'cmip5data' class
loadCMIP5

Load CMIP5 data
filterDimensionTimeYears

Filter time (years) dimension.
calcGridArea

Calculate the grid cella area for a centered lat/lon grid
as.data.frame.cmip5data

Convert a cmip5data object to a data frame
makePackageData

Make package datasets and write them to disk.
as.array.cmip5data

Convert a cmip5data object to an array
filterDimensionZ

Filter Z dimension.
restoreMissingDims

Restore missing and/or degenerate dimensions in the data
filterDimensions

Filter dimensions, limiting to arbitrary lon/lat/Z/time
getFileInfo

List all CMIP5 files in a directory tree
makeGlobalStat

Compute global statistic of a variable
addProvenance

Add provenance information to a cmip5data object
print.cmip5data

Print a 'cmip5data' class object.
filterDimensionTimeMonths

Filter time (months) dimension.
makeAnnualStat

Compute annual statistic of a variable
worldPlot

Plot global data
print.summary.cmip5data

Print the summary for a 'cmip5data' class object.
saveNetCDF

Save a cmip5data object to NetCDF format
mergeExperiments

Merge data for two separate experiments
RCMIP5

Tools for Manipulating and Summarizing CMIP5 Data
makeZStat

Compute Z-dimension statistic of a variable
weighted.sum

Weighted sum--i.e., sum of weighted means. Convenience function
summary.cmip5data

Summarize a 'cmip5data' class object.
filterDimensionLon

Filter longitude dimension.
loadEnsemble

Load a unique CMIP5 ensemble