Learn R Programming

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

Copy Link

Version

Install

install.packages('RCMIP5')

Monthly Downloads

9

Version

1.2.0

License

MIT + file LICENSE

Maintainer

Kathe ToddBrown

Last Published

July 30th, 2016

Functions in RCMIP5 (1.2.0)

convert_array_to_df

Convert array format cmip5data to data frame format
cmip5data

The 'cmip5data' class
cmip5.weighted.mean

Alternative weighted mean
checkTimePeriod

Check for continuous time periods in CMIP5 files
calcGridArea

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

Convert a cmip5data object to a data frame
filterDimensionLat

Filter latitude dimension.
addProvenance

Add provenance information to a cmip5data object
filterDimensionLon

Filter longitude dimension.
loadCMIP5

Load CMIP5 data
filterDimensionZ

Filter Z dimension.
getFileInfo

List all CMIP5 files in a directory tree
as.array.cmip5data

Convert a cmip5data object to an array
loadEnsemble

Load a unique CMIP5 ensemble
makeAnnualStat

Compute annual statistic of a variable
getProjectionMatrix

Calculate projection matrix to translate one grid to another
makeGlobalStat

Compute global statistic of a variable
filterDimensionTimeYears

Filter time (years) dimension.
filterDimensions

Filter dimensions, limiting to arbitrary lon/lat/Z/time ranges
filterDimensionTimeMonths

Filter time (months) dimension.
print.summary.cmip5data

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

Project the values of a cmip5data object onto a new grid
RCMIP5

Tools for Manipulating and Summarizing CMIP5 Data
print.cmip5data

Print a 'cmip5data' class object.
restoreMissingDims

Restore missing and/or degenerate dimensions in the data
mergeExperiments

Merge data for two separate experiments
makeZStat

Compute Z-dimension statistic of a variable
makeMonthlyStat

Compute monthly statistic of a variable
nvals

Return number of data values
makePackageData

Make package datasets and write them to disk.
vals

Return data values
saveNetCDF

Save a cmip5data object to NetCDF format
worldPlot

Plot global data
summary.cmip5data

Summarize a 'cmip5data' class object.