Learn R Programming

RCMIP5 (version 1.2.0)

addProvenance: Add provenance information to a cmip5data object

Description

It's important to track data provenance, the steps taken to produce a particular dataset. Each operation in the RCMIP5 package adds provenance information via this function.

Usage

addProvenance(x, msg, verbose = FALSE)

Arguments

x
A cmip5data object
msg
Either a string (message to be added to the provenance) or a cmip5data object, in which case the provenance of this latter object is appended to that of x (i.e., their histories are merged)
verbose
logical. Print info as we go?

Value

The original object, with an updated provenance containing:

Details

We want to track computational steps applied to a particular cmip5data object, for reproducibility and user debugging. This function logs information from the caller to a 'provenance' data structure.