vmeasure_calc {sabre}R Documentation

V-measure calculation

Description

It calculates a degree of spatial association between regionalizations using an information-theoretical measure called the V-measure

Usage

vmeasure_calc(x, y, x_name, y_name, B = 1, precision = NULL)

## S3 method for class 'sf'
vmeasure_calc(x, y, x_name, y_name, B = 1, precision = NULL)

## S3 method for class 'stars'
vmeasure_calc(x, y, x_name = NULL, y_name = NULL, B = 1, precision = NULL)

## S3 method for class 'SpatRaster'
vmeasure_calc(x, y, x_name = NULL, y_name = NULL, B = 1, precision = NULL)

## S3 method for class 'RasterLayer'
vmeasure_calc(x, y, x_name = NULL, y_name = NULL, B = 1, precision = NULL)

Arguments

x

An object of class sf with a POLYGON or MULTIPOLYGON geometry type or a spatial raster object of class RasterLayer, SpatRaster, or stars.

y

An object of class sf with a POLYGON or MULTIPOLYGON geometry type or a spatial raster object of class RasterLayer, SpatRaster, or stars.

x_name

A name of the column with regions/clusters names.

y_name

A name of the column with regions/clusters names.

B

A numeric value. If B > 1 then completeness is weighted more strongly than homogeneity, and if B < 1 then homogeneity is weighted more strongly than completeness. By default this value is 1.

precision

numeric, or object of class units with distance units (but see details); see st_as_binary for how to do this.

Value

A list with five elements:

References

Nowosad, Jakub, and Tomasz F. Stepinski. "Spatial association between regionalizations using the information-theoretical V-measure." International Journal of Geographical Information Science (2018). https://doi.org/10.1080/13658816.2018.1511794

Rosenberg, Andrew, and Julia Hirschberg. "V-measure: A conditional entropy-based external cluster evaluation measure." Proceedings of the 2007 joint conference on empirical methods in natural language processing and computational natural language learning (EMNLP-CoNLL). 2007.

Examples

library(sf)
data("regions1")
data("regions2")
vm = vmeasure_calc(x = regions1, y = regions2, x_name = z, y_name = z)
vm

plot(vm$map1["rih"])
plot(vm$map2["rih"])

library(raster)
data("partitions1")
data("partitions2")
vm2 = vmeasure_calc(x = partitions1, y = partitions2)
vm2

plot(vm2$map1[["rih"]])
plot(vm2$map2[["rih"]])


[Package sabre version 0.4.3 Index]