SymbLegend: Plot Legend

View source: R/SymbLegend.R

SymbLegendR Documentation

Plot Legend

Description

Plots symbols and Legend on a map. There are two different methods (percentile symbols or boxplot symbols) to display the legend.

Usage

SymbLegend(X, Y, z, type = "percentile", qutiles = c(0, 0.05, 0.25, 0.75, 0.95, 1),
q = NULL, symbtype = "EDA", symbmagn = 0.8, leg.position = "topright",
leg.title = "", leg.title.cex = 0.8, leg.round = 2, leg.wid = 4, leg.just = "right",
cex.scale = 0.8, xf = 9000, logscale = TRUE, accentuate = FALSE)

Arguments

X

X-coordinates

Y

Y-coordinates

z

values on the coordinates

type

"percentile" for percentile legend, "boxplot" for boxplot legend

qutiles

considered quantiles if type="percentile" is used

q

if not NULL, provide manually data points where to break

symbtype

type of symbols to be used; "EDA", "EDAacc", "EDAacc2", "EDAext", "GSC" or "arbit"

symbmagn

magnification factor for symbols

leg.position

position of the legend, either character like "topright" or coordinates

leg.title

title for legend

leg.title.cex

cex for legend

leg.round

round legend to specified digits "pretty"

leg.wid

width (space in numbers) for legend

leg.just

how to justify the legend

cex.scale

cex for text "log-scale" and for boxplot legend - only for type="boxplot"

xf

x-distance from boxplot to number for legend

logscale

if TRUE a log scale is used (for boxplot scale) and the log-boxplot is computed

accentuate

if TRUE, accentuated symbols are used (here only EDA accentuated!)

Details

It is possible to choose between different methods for calculating the range of the values for the different symbols.

If type="percentile" the pre-determined quantiles of the data are computed and are used to plot the symbols. If type="boxplot" a boxplot is computed and the values were taken to group the values fot the plot and the legend. In the case that a log scale is used the function boxplotlog is used instead of boxplot.

Value

No return value, creates a plot.

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

data(chorizon)
data(kola.background)
el=chorizon[,"As"]
X=chorizon[,"XCOO"]
Y=chorizon[,"YCOO"]

plot(X,Y,frame.plot=FALSE,xaxt="n",yaxt="n",xlab="",ylab="",type="n")
plotbg(map.col=c("gray","gray","gray","gray"),add.plot=TRUE)

SymbLegend(X,Y,el,type="percentile",qutiles<-c(0,0.05,0.25,0.75,0.95,1),symbtype="EDA",
symbmagn=0.8,leg.position="topright",leg.title="As [mg/kg]",leg.title.cex=0.8,leg.round=2,
leg.wid=4,leg.just="right")

StatDA documentation built on June 7, 2023, 6:26 p.m.

Related to SymbLegend in StatDA...