diffeR (version 0.0-8)

overallComponentsPlot: Overall Components plot

Description

If comparison and reference (raster) maps are provided, this function creates the Overall Components plot from the comparison between the comparison map (or map at time t) and the reference map (or map at time t+1). If a square contingency table (matrix) is provided instead of raster maps, then this function creates the Overall Components plot from the comparison between the comparison variable (or variable at time t) and the reference variable (or variable at time t+1).

Usage

overallComponentsPlot(comp = NULL, ref = NULL, ctmatrix = NULL, 
                      units = NULL, population = NULL, 
                      graphics_system = 'ggplot2')

Value

a stacked barplot showing the quantity, exchange and shift components of difference between the comparison map/variable (or map/variable at time t) and the reference map/variable (or map/variable at time t+1)

Arguments

comp

object of class SpatRaster corresponding to a comparison map (or map at time t). See Details below

ref

object of class SpatRaster corresponding to a reference map (or map at time t+1). See Details below

ctmatrix

matrix representing a square contingency table between a comparison variable (rows) and a reference variable (columns).. See Details below

units

character string indicating units of ctmatrix

population

an n x 2 matrix provided to correct the sample count to population count in the square contingency table. See Details below

graphics_system

character string indicating the graphics system for creating the plot, either "ggplot2" (default) or "graphics" (for base R graphics system)

Details

Users may enter as input either a square contingency table (ctmatrix) or a comparison and a reference raster maps (comp and ref, respectively).

The first column of population must contain integer identifiers of each category, corresponding to the categories in the comparison and reference variables. The second column corresponds to the population totals for each category.

References

Pontius Jr., R.G., Millones, M. 2011. Death to Kappa: birth of quantity disagreement and allocation disagreement for accuracy assessment. International Journal of Remote Sensing 32 (15), 4407-4429.

Examples

comp <- rast(system.file("external/comparison.rst", package = "diffeR"))
ref <- rast(system.file("external/reference.rst", package = "diffeR"))
overallComponentsPlot(comp, ref)

ctmat <- crosstabm(comp, ref)
overallComponentsPlot(ctmatrix = ctmat, units = "pixels")