Scheme-class: A classification scheme

Scheme-classR Documentation

A classification scheme

Description

This class stores the information about a classification scheme, for example a biome classification scheme. It describes what how the model output (in the form of a data.table) must be prepared, and then the rules which are used to do the classification.

Slots

id

A unique character string to identify this particular classification scheme. Recommended to be alphanumeric because it is used to construct file names. (Inherited from Quantity via "contains")

name

A character string that can be more descriptive of the classification scheme. (Inherited from Quantity via "contains")

units

A list of character strings giving the names of categories. (Inherited from Quantity via "contains")

colours

A function that returns the colour scale for this Scheme. (Inherited from Quantity via "contains")

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.

rules

A function which is applied to every row of the data.table and describes the classification rules.

layers.needed

List of vegetation layers needed to perform the classification and the name of the new layer, to be interpreted by layerOp, specified as a list of three- or four-item list whose elements first element id the id of a Quantity and whose other elements are passed as arguments to the layerOp function. For example one element could be Woody = list(quantity = "LAI_std", operator = "+", layers = c(".Tree", ".Shrubs"), new.layer = "Woody"), which would make a layer called "Woody" which would be the sum of all LAI trees and shrubs.

data.reference

Character string giving a reference where the data for this classification scheme comes from

published.reference

Character string giving a reference where this model output classification scheme was published

Author(s)

Matthew Forrest matthew.forrest@senckenberg.de


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