legendPropLines: Legend for Proportional Lines Maps

View source: R/legends.R

legendPropLinesR Documentation

Legend for Proportional Lines Maps

Description

Plot legend for proportional lines maps

Usage

legendPropLines(
  pos = "topleft",
  title.txt = "Title of the legend",
  title.cex = 0.8,
  cex = 1,
  values.cex = 0.6,
  var,
  lwd,
  col = "red",
  frame = FALSE,
  values.rnd = 0
)

Arguments

pos

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

title.txt

title of the legend.

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

vector of values (at least min and max).

lwd

width of the larger line.

col

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.

Examples

library(sf)
mtq <- st_read(system.file("gpkg/mtq.gpkg", package="cartography"))
plot(st_geometry(mtq))
box()
legendPropLines(pos = "topleft", title.txt = "Title",
                title.cex = 0.8, values.cex = 0.6, cex = 1,
                var = c(10,100),
                lwd = 15,
                col="red", frame=TRUE, values.rnd=0)

cartography documentation built on Sept. 14, 2023, 5:08 p.m.