Quantity-class: Class to hold meta-data for a vegetation quantity

In MagicForrest/DGVMTools: DGVM Processing, Analysis and Plotting Tools

Class to hold meta-data for a vegetation quantity

Description

This class hold meta-data for specific vegetation or land surface quantities like "lai" (LAI) or "mwcont_upper" (mean monthly water). Includes the units it is measured, different identifiers/labels, the Format object the Quantity is associated with and a default colour scheme for plotting it, See the 'Slots' documentation below. Note that for some analyses user will probably need to define their own, and modify these for their own analysis and plots. However the standard quantities that one expects to be available from different models are listed below in the 'Usage' section.

Usage

GUESS.quantities

NetCDF.quantities

aDGVM.quantities

aDGVM2.quantities

Standard.quantities

Format

The Quantity class is an S4 class with the slots defined below

The Quantity class is an S4 class with the slots defined below

The Quantity class is an S4 class with the slots defined below

The Quantity class is an S4 class with the slots defined below

An object of class list of length 23.

Details

Note that quantities in the Standard.quantities list should ideally be defined for all model types.

Slots

id

A unique character string to identify this particular vegetation quantity. This will be interpreted for an output-format specific function, but should ideally match with the name of a particular model output/dataset variable. Recommended to be alphanumeric because it is used to construct file names.

name

A longer character string to provide a more complete description of this quantity

units

A character string defining the units this quantity is defined in.

colours

A function that returns a colour scale suited for plotting this quantity.

format

Either a the string "Standard" to denote that this is a standard quantity to be compared across all model and data, the id of the Format object with which this Quantity is associated.

standard_name

A character string for the "standard_name" or "long_name" attribute for a CF-compliant netCDF file. Won't make sense for all variables (not all DGVM quantities have a CF defined variable), but it makes sense to use this where possible.

Author(s)

Matthew Forrest [e-mail]

See Also

lookupQuantity

MagicForrest/DGVMTools documentation built on Aug. 23, 2024, 8:05 a.m.