Tools for Manipulating and Summarizing CMIP5 Data

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 standard, robust, and high-performance set of scripts 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.


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 CMIP5 can be found on the project home page, 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, 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.

Bug reports

  • CMIP5 data are highly variable in their structure and assumptions, and there are undoubtedly edge 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, give us a reproducible example: tell us (i) what file(s) you were trying to process, (ii) what sequence of operations led to the problem, (iii) the output of sessionInfo(), and (iv) 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").
  • Behind the scenes, RCMIP5 uses the dplyr package for heavy data lifting. It optionally can use an array implementation, depending on abind.
  • Want to get started? An extensive vignette and demo are included with the package.

News

RCMIP5 1.2

  • Code handles irregular spatial grids.

  • Remove ncdf package dependency, ncdf4 is now required.

  • Now use assertthat for pre- and post-assertions.

  • Vignette updates.

  • Bug fixes: file close on loadEnsemble() skip (#106); fractional yearRange (#107); overlapping files (#109).

  • Data sorting now optional for all stat operations (#112).

  • New ZRange parameter allows loadCMIP5 to only load parts of files.

  • Updates for dplyr 0.5 and testthat 1.0.

RCMIP5 1.1

  • Much faster thanks to shifting computations from plyr and abind to dplyr.

  • New checks for odd edge cases in loadEnsemble().

  • Provenance now handles multi-line custom functions correctly.

  • Removed support for old ncdf from saveNetCDF().

  • Many new tests.

RCMIP5 1.0

  • First release of the RCMIP5 package.

  • More information at https://github.com/JGCRI/RCMIP5.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("RCMIP5")

1.2.0 by Kathe Todd-Brown, a year ago


Browse source code at https://github.com/cran/RCMIP5


Authors: Ben Bond-Lamberty [aut], Kathe Todd-Brown [aut, cre]


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports abind, dplyr, assertthat, digest, Matrix

Suggests ggplot2, ncdf4, testthat, knitr


See at CRAN