legendWaffle: Legend for Typology Maps

View source: R/legendWaffle.R

legendWaffleR Documentation

Legend for Typology Maps

Description

Plot legend for typology maps.

Usage

legendWaffle(
  pos = "topleft",
  title.txt = "Title of the legend",
  title.cex = 0.8,
  values.cex = 0.6,
  categ,
  cex = 1,
  cell.txt = "1 cell = ...",
  col,
  cell.size,
  border = "white",
  lwd = 0.2,
  frame = FALSE
)

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.

values.cex

size of the values in the legend.

categ

vector of categories.

cex

size of the legend. 2 means two times bigger.

cell.txt

label for cell values.

col

a vector of colors.

cell.size

size of the cell

border

color of the cells borders.

lwd

width of the cells borders

frame

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

Examples

library(sf)
mtq <- st_read(system.file("gpkg/mtq.gpkg", package="cartography"))
plot(st_geometry(mtq))
box()

# Define labels and colors
someLabels <- c("red color", "yellow color", "green color", "black color")
someColors <- c("red", "yellow", "green", "black")
legendWaffle(categ = someLabels, col = someColors, cell.size = 750)

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