tmap (version 1.0)

tm_lines: Draw spatial lines

Description

Creates a tmap-element that draw spatial lines.

Usage

tm_lines(col = "red", lwd = 1, lty = "solid", alpha = NA, scale = 1,
  n = 5, style = "pretty", breaks = NULL, palette = NULL,
  labels = NULL, auto.palette.mapping = TRUE, contrast = 1,
  max.categories = 12, colorNA = "grey65", textNA = "Missing",
  text_separator = "to", text_less_than = "Less than",
  text_or_more = "or more", title.col = NA, title.lwd = NA,
  legend.col.is.portrait = TRUE, legend.lwd.is.portrait = FALSE,
  legend.hist = FALSE, legend.hist.title = NA, legend.col.z = NA,
  legend.lwd.z = NA, legend.hist.z = NA)

Arguments

col

color of the lines. Either a color value or a data variable name.

lwd

line width

lty

line type

alpha

transparency number between 0 (totally transparent) and 1 (not transparent). By default, the alpha value of the col is used (normally 1).

scale

line width multiplier number.

n

preferred number of color scale classes. Only applicable when lwd is the name of a numeric variable.

style

method to cut the color scale: e.g. "fixed", "equal", "pretty", "quantile", or "kmeans". See the details in classIntervals. Only applicable when lwd is the name of

breaks

in case style=="fixed", breaks should be specified

palette

color palette (see RColorBrewer::display.brewer.all) for the lines. Only when col is set to a variable.

labels

labels of the classes

auto.palette.mapping

When diverging colour palettes are used (i.e. "RdBu") this method automatically maps colors to values such that the middle colors (mostly white or yellow) are assigned to values of 0, and the two sides of the color palette are assigned to negative respect

contrast

vector of two numbers that determine the range that is used for sequential and diverging palettes (applicable when auto.palette.mapping=TRUE). Both numbers should be between 0 and 1. The first number determines where the palette begins, and t

max.categories

in case col is the name of a categorical variable, this value determines how many categories (levels) it can have maximally. If the number of levels is higher than max.categories, then levels are combined.

colorNA

color used for missing values

textNA

text used for missing values. Use NA to omit text for missing values in the legend

text_separator

Character string to use to separate numbers in the legend (default: "to").

text_less_than

Character string to use to translate "Less than" (which is the default).

text_or_more

Character string to use to translate "or more" (which is the default).

title.col

title of the legend element regarding the line colors

title.lwd

title of the legend element regarding the line widths

legend.col.is.portrait

logical that determines whether the legend element regarding the line colors is in portrait mode (TRUE) or landscape (FALSE)

legend.lwd.is.portrait

logical that determines whether the legend element regarding the line widths is in portrait mode (TRUE) or landscape (FALSE)

legend.hist

logical that determines whether a histogram is shown regarding the line colors

legend.hist.title

title for the histogram. By default, one title is used for both the histogram and the normal legend for line colors.

legend.col.z

index value that determines the position of the legend element regarding the line colors with respect to other legend elements. The legend elements are stacked according to their z values. The legend element with the lowest z value is placed on top.

legend.lwd.z

index value that determines the position of the legend element regarding the line widths. (See legend.col.z)

legend.hist.z

index value that determines the position of the legend element regarding the histogram. (See legend.col.z)

Value

• tmap-element

See Also

../doc/tmap-nutshell.html{vignette("tmap-nutshell")}

Examples

data(rivers)
data(World)
data(Europe)

tm_shape(World) +
  tm_fill("darkolivegreen3") +
tm_shape(rivers) +
  tm_lines(col="navy") +
tm_layout_World("Rivers of the World", inner.margins = c(0,0,.1,0))

tm_shape(Europe) +
  tm_fill("darkolivegreen3") +
  tm_borders("white") +
tm_shape(rivers) +
  tm_lines(col="navy", lwd="scalerank", scale=2) +
tm_layout("Rivers of Europe", legend.show=FALSE)