rgr: map.eda8 – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

map.eda8

Plot a Symbol Map of Data Based on their Percentiles

Description

Displays a simple map where the data are represented at their spatial locations by symbols indicating within which group defined by the data's 2nd, 5th, 25th, 50th, 75th, 95th and 98th percentiles plotted a data value falls. The colours of the symbols may be optionally changed. Optionally a legend (two options) may be added to the map.

Usage

map.eda8(xx, yy, zz, sfact = 1, xlab = "Easting", ylab = "Northing", 
	zlab = deparse(substitute(zz)), main = "", ifgrey = FALSE,  
	symcolr = NULL, tol = 0.04, iflgnd = FALSE, pctile = FALSE,
	title = deparse(substitute(zz)), cex.lgnd = 0.8, ...)

Arguments

`xx`	name of the x-axis spatial coordinate, the eastings.
`yy`	name of the y-axis spatial coordinate, the northings.
`zz`	name of the variable to be plotted.
`sfact`	controls the absolute size of the plotted symbols, by default `sfact = 1`. Increasing sfact results in larger symbols.
`xlab`	a title for the x-axis, defaults to `Easting`.
`ylab`	a title for the y-axis, defaults to `Northing`.
`zlab`	by default, `zlab = deparse(substitute(zz))`, a map title is generated by appending the input variable name text string to `"EDA Percentile Based Map for "`. Alternative titles may be generated, see Details below.
`main`	an alternative map title, see Details below.
`ifgrey`	set `ifgrey = TRUE` if a grey-scale map is required, see Details below.
`symcolr`	the default is a colour map and default colours are provided, deeper blues for lower values, green for the middle 50% of the data, and oranges and reds for higher values. A set of alternate symbol colours can be provided by defining `symcolr`, see Details below.
`tol`	a parameter used to ensure the area included within the neatline around the map is larger than the distribution of the points so that the plotted symbols fall within the neatline. By default `tol = 0.04`, if more clearance is required increase the value of `tol`.
`iflgnd`	the default is no legend. If a legend is required set `iflgnd = TRUE`, following the plotting of the data the cursor will be activated, locate that at the top left corner of the desired legend position and ‘left button’ on the pointing device. There are two legends to choose from, see `pctile` below.
`pctile`	the default legend displays the range of values each symbol represents. Alternately, the percentiles may be displayed rather than their values by setting `pctile = TRUE`.
`title`	a short title for the legend, e.g., `title = "Cu (mg/kg)"`. The default is the character string for `zz`.
`cex.lgnd`	controls the scaling of the legend box and text, but not the symbols so that they match those on the map, the default is `cex.lgnd = 0.8`.
`...`	further arguments to be passed to methods. For example, if it is required to make the map title smaller, add `cex.main = 0.9` to reduce the font size by 10%.

Details

The selected percentiles, 2nd, 5th, 25th, 50th, 75th, 95th and 98th, divide the data into 8 groups. Values below the median are represented by increasingly larger deeper blue circles below the 25th percentile (Q1), and values above the 75th percentile (Q3) by increasingly larger orange and red squares. The mid 50% of the data are represented by green symbols, circles for the median (Q2) to Q1, and squares for the median (Q2) to Q3.

A summary table of the values of the symbol intervals, the number of values plotting as each symbol, and symbol shapes, sizes and colours is displayed on the current device.

If zlab and main are undefined a default a map title is generated by appending the input variable name text string to "EDA Percentile Based Map for ". If no map title is required set zlab = "", and if some user defined map title is required it should be defined in main, e.g. main = "Map Title Text".

If the grey-scale option is chosen the symbols are plotted 100% black for the far outliers, 85% black for the near outliers, 70% black for values within the whiskers, and 60% black for values falling within the middle 50% of the data.

The default colours, symcolr = c(25, 22, 20, 13, 13, 6, 4, 1), are selected from the rainbow(36) pallette, and alternate colour schemes need to be selected from the same palette. See display.rainbow for the available colours. It is essential that 8 colours be provided, e.g., symcolr = c(27, 24, 22, 12, 12, 5, 3, 36), if exactly 8 are not provided the default colours will be displayed.

Note

Any less than detection limit values represented by negative values, or zeros or other numeric codes representing blanks in the data, must be removed prior to executing this function, see ltdl.fix.df.

Any data vectors including NAs are removed prior to displaying the plot.

In some R installations the generation of multi-panel displays and the use of function eqscplot from package MASS causes warning messages related to graphics parameters to be displayed on the current device. These may be suppressed by entering options(warn = -1) on the R command line, or that line may be included in a ‘first’ function prepared by the user that loads the ‘rgr’ package, etc.

Author(s)

Robert G. Garrett

Examples

## Make test data available
data(kola.o)
attach(kola.o)

## Plot a default symbol map
map.eda8(UTME, UTMN, Cu)

## Plot a more appropriately labelled map
map.eda8(UTME/1000, UTMN/1000, Cu, 
	xlab = "Kola Project UTM Eastings (km)",
	ylab = "Kola Project UTM Northings (km)") 

## Plot a grey-scale equivalent of the above map
map.eda8(UTME/1000, UTMN/1000, Cu, ifgrey = TRUE,
	xlab = "Kola Project UTM Eastings (km)",
	ylab = "Kola Project UTM Northings (km)") 

## Plot the same map with an alternate colour scheme
map.eda8(UTME/1000, UTMN/1000, Cu,
	xlab = "Kola Project UTM Eastings (km)",
	ylab = "Kola Project UTM Northings (km)",
	symcolr = c(27, 24, 22, 12, 12, 5, 3, 36)) 

## Detach test data
detach(kola.o)

rgr

Applied Geochemistry EDA

v1.1.15

GPL-2

Authors

Robert G. Garrett

Initial release

2018-03-05