StatDA: boxplotlegend – R documentation

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

boxplotlegend

Boxplotlegend

Description

This function plots the legend in form of a boxplot. The symbols represent the different levels (e.g. whiskers, median, ...) of the boxplot.

Usage

boxplotlegend(X, Y, el, boxinfo, x.shift = 40000, xf = 10000, y.shift = 0.2,
y.scale = 130000, legend.title = "Legend", cex.legtit = 1, logscale = TRUE,
symb = c(1, 1, 16, 3, 3), ssize = c(1.5, 1, 0.3, 1, 1.5), accentuate = FALSE,
cex.scale = 0.8)

Arguments

`X`	X-coordinates
`Y`	Y-coordinates
`el`	variable considered
`boxinfo`	from boxplot(el) or boxplotlog(el)
`x.shift`	shift in x-direction
`xf`	width in x-direction
`y.shift`	shift in y-direction (from title)
`y.scale`	scale in y-direction
`legend.title`	title for legend
`cex.legtit`	cex of title for legend
`logscale`	if TRUE plot boxplot in log-scale
`symb`	symbols to be used (length 5!)
`ssize`	symbol sizes to be used (length 5!)
`accentuate`	if FALSE no symbols for the upper values (e.g. upper "hinge", upper whisker) are assigned
`cex.scale`	cex for text "log-scale" for scale

Details

Takes the information provided by the argument boxinfo and plots a boxplot corresponding to the values. If there are no upper or/and lower outliers the symbols for the upper or/and lower whiskers will be ignored.

Value

Plots the legend with respect to the boxplot and returns the symbols, size and the quantiles used for the legend.

Author(s)

Peter Filzmoser <P.Filzmoser@tuwien.ac.at> http://cstat.tuwien.ac.at/filz/

References

C. Reimann, P. Filzmoser, R.G. Garrett, and R. Dutter: Statistical Data Analysis Explained. Applied Environmental Statistics with R. John Wiley and Sons, Chichester, 2008.

Examples

#internal function, used in SymbLegend

StatDA

Statistical Analysis for Environmental Data

v1.7.4

GPL (>= 3)

Authors

Peter Filzmoser

Initial release

2020-03-10