Comparison-class: Contains a comparison between two layers
In MagicForrest/DGVMTools: DGVM Processing, Analysis and Plotting Tools

Comparison-class

R Documentation

Contains a comparison between two layers

Description

This object is produced as the result of a call to the functions compareLayers and shouldn't be directly created by a user.

It contains a data slot with each of the compared layers, a list containing various statistical metrics, meta-data about the source of the two compared layers and spatio-temporal meta-data describing where the comparison is valid.

Details

It can be plotted by functions plotSpatialComparison and plotTemporalComparison.

Generally these are not created directly by the user, but rather by the function compareLayers.

Slots

id

A unique character string to identify this particular vegetation object. Recommended to be alphanumeric because it is used to construct file names.

name

A character string describing this comparison layer, is automatically generated

type

A character string describing what type of comparisons this is (automatically determined). Can be

"continuous"A comparison of two continous, numerical layers.
"categorical"A comparison of two categorical layers.
"relative.abundance" A comparison of multiple numerical layers whose sum equals unity.
"seasonal" A comparison of the seasonal concentration and phase calculated from two numerical layers which have monthly data.

data

A data.table object. This is used because is it very much faster for calculations that data.frame or raster layers.

quant1

A Quantity object to define what quantity the data from first field represents

quant2

A Quantity object to define what quantity the data from second field represents

layers1

A character string (or vector thereof) of the layer(s) from the first field that were compared

layers2

A character string (or vector thereof) of the layer(s) from the second field that were compared

stats

A simple R list containing the (named) statistics produced by the comparison (very flexible, items will depend on the type of comparison done and can even be a another list)

source1