categoricalComparison: Comparison between two datasets of categorical variables

View source: R/benchmarking.R

categoricalComparisonR Documentation

Comparison between two datasets of categorical variables

Description

Calculates a Statistics object (which contains the Cohen's Kappa scores) given data.table of with two layers of categorical data (eg. biomes, land cover classes).

Usage

categoricalComparison(
  x,
  layers1,
  layers2,
  additional,
  verbose = TRUE,
  area = TRUE
)

Arguments

x

A data.table containing the spatial-temporal-annual columns and two columns containg the data to be compared

layers1

A character string giving the first layer to compare (should be a column in x)

layers2

A character string giving the second layer to compare (should be a column in x)

additional

A list of functions define additions metrics, see the custom.metrics argument of compareLayers

verbose

A logical, if TRUE print out all the Kappa scores

area

A logical, if true weight the metrics by gridcell area (not currently implemented)

Note that there are many other slots in a Statistics object which will not be filled in the resulting object because they are for continuous as opposed to categorical data

Value

A named list of metric statistics

Author(s)

Matthew Forrest matthew.forrest@senckenberg.de


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