mf_legend_pl: Plot a legend for a proportional lines map

View source: R/mf_leg_pl.R

mf_legend_plR Documentation

Plot a legend for a proportional lines map

Description

Deprecated.

This function plots a legend for proportional lines.

Usage

mf_legend_pl(
  pos = "left",
  val,
  lwd,
  col = "tomato4",
  title = "Legend Title",
  title_cex = 0.8,
  val_cex = 0.6,
  val_rnd = 0,
  frame = FALSE,
  bg,
  fg,
  cex = 1
)

Arguments

pos

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

val

vector of values (at least min and max).

lwd

width of the largest line

col

color of the lines

title

title of the legend

title_cex

size of the legend title

val_cex

size of the values in the legend

val_rnd

number of decimal places of the values in the legend.

frame

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

bg

background of the legend

fg

foreground of the legend

cex

size of the legend; 2 means two times bigger

Value

No return value, a legend is displayed.

Examples

## Not run: 
plot.new()
plot.window(xlim = c(0, 1), ylim = c(0, 1), asp = 1)
mf_legend_pl(lwd = 20, val = c(5, 10, 50, 100))

## End(Not run)

mapsf documentation built on Sept. 11, 2024, 8:19 p.m.