legendPropTriangles {cartography}

Legend for Double Proportional Triangles Maps

Description

Plot legends for double proportional triangles maps.

Usage

legendPropTriangles(
  pos = "topleft",
  title.txt,
  var.txt,
  var2.txt,
  title.cex = 0.8,
  cex = 1,
  values.cex = 0.6,
  var,
  var2,
  r,
  r2,
  col = "red",
  col2 = "blue",
  frame = FALSE,
  values.rnd = 0,
  style = "c"
)

Arguments

pos

position of the legend, one of "topleft", "top", "topright", "right", "bottomright", "bottom", "bottomleft", "left" or a vector of two coordinates in map units (c(x, y)).

title.txt

title of the legend.

var.txt

name of var.

var2.txt

name of var2.

title.cex

size of the legend title.

cex

size of the legend. 2 means two times bigger.

values.cex

size of the values in the legend.

var

a first vector of positive values.

var2

a second vector of positive values.

r

a first vector of sizes.

r2

a second vector of sizes.

col

color of symbols.

col2

second color of symbols.

frame

whether to add a frame to the legend (TRUE) or not (FALSE).

values.rnd

number of decimal places of the values in the legend.

style

either "c" or "e". The legend has two display styles, "c" stands for compact and "e" for extended.

Examples

library(sf)
mtq <- st_read(system.file("gpkg/mtq.gpkg", package="cartography"))
plot(st_geometry(mtq))
box()
var <- runif(10, 0,100)
var2 <- runif(10, 0,100)
r <- sqrt(var)*1000
r2 <- sqrt(var2)*1000
legendPropTriangles(pos = "topright", var.txt = "population 1",
                    var2.txt = "population 2", title.txt="Population totale",
                    title.cex = 0.8, values.cex = 0.6, cex = 1,
                    var = var, var2 = var2, r = r, r2 = r2,
                    col="green", col2="yellow", frame=TRUE, values.rnd=2,
                    style="c")