EnvResamplePlot: A function to test environmental inequality indices by...

View source: R/SegEnvIneq.R

EnvResamplePlotR Documentation

A function to test environmental inequality indices by resampling

Description

Plot of resampling simulations results.

Usage

EnvResamplePlot(ResampleTest, var = 1,  coldist = "red", colind = "blue", legend = TRUE,
legendpos = "top", cex.legend = 1, bty = "o")

Arguments

ResampleTest

- a ResampleTest object produced with ResampleTest function

var

- the number of the variable to be plot

coldist

- color used to plot the simulated distribution

colind

- color used to plot the index

legend

- logical parameter, to control the legend's plots

legendpos

- a character string giving the legend's position: 'bottomright', 'bottom', 'bottomleft', 'left', 'topleft', 'top', 'topright', 'right' and 'center'.

cex.legend

- a numerical value giving the amount by which plotting text and symbols in legend should be magnified relative to the default.

bty

- a character string which determines the type of box of the legend: 'o' (by default), 'l', '7', 'c', 'u', or ']'

Value

A plot with resampling distribution corresponding upper case letter. A value of 'n' suppresses the box.

References

Schaeffer Y. and Tivadar M. (2019) Measuring Environmental Inequalities: Insights from the Residential Segregation Literature. Ecological Economics, 164, 106329

Tivadar M. (2019) OasisR: An R Package to Bring Some Order to the World of Segregation Measurement. Journal of Statistical Software, 89 (7), pp. 1-39

See Also

EDfunc, ECfunc, EnvResampleTest

Examples

data(segdata, package = "OasisR")
# segdata - theoretical distributions on a 10x10 grid map
# We consider A1 - population distribution and A2 - amenity distribution
testoutput <- EnvResampleTest (x = segdata@data$A1, a = segdata@data$A2, spatobj = segdata,
fun = "EDfunc", vers = "contig", queen = FALSE)
EnvResamplePlot(testoutput)

SegEnvIneq documentation built on Aug. 30, 2023, 9:06 a.m.