Source-class: Metadata for a data source
In MagicForrest/DGVMTools: DGVM Processing, Analysis and Plotting Tools

Source-class

R Documentation

Metadata for a data source

Description

This class describes a data source, including its location on disk, the format (ie from which model or dataset it came), the PFT set used, an unique id and a description, offsets to apply to the longitudes and latitudes to make the co-rordinates gridcell centered and so on. It is not primarily intended to be used by itself. Instead it is inherited bySource object (due to this inheritance the slots can be accessed directly) and included in a Field in the @source slot (not inherited, so needs to be access be @source).

Details

Slots can be accessed and modified by the user directly, but also by functions defineQuantity and defineLayer with the add.to argument.

Slots

id: A unique character string to identify this particular data source. Recommended to be alphanumeric because it is used to construct file names. (Mandatory)
dir: The location of this run on the file system (Mandatory)
format: A character string or a Format object to describe how this data is stored on disk. This will depend on either the model that was used to produce it or the dataset type. Currently defined Format objects are GUESS, aDGVM, aDGVM2 and NetCDF. (Mandatory)
defined.layers: A list of Layer objects to describe the Layers, includes the PFTs, included in this model run/dataset.
name: A character string describing this data source, ie. "LPJ-GUESS v3.1" (can be omitted, in which case the id will be used instead)
forcing.data: A character string identifying the climate or other data used to produce this data
lonlat.offset: A numeric of length 1 or 2 to define the offsets to Lon and Lat to centre the modelled localities.
year.offset: A numeric of length 1 to match be added to the simulation years to convert them to calendar years
london.centre: If TRUE, ensure that the longitudes are (-180,180) instead of (0,360)
land.use.included: If TRUE it can be assumed that land use has been simulated for this run and so no correction for land use need be applied before benchmarking.
contact: Name and email address of responsible person.
institute: Name of the institute (default "none").