Learn R Programming

tmap (version 0.7)

tm_bubbles: Draw bubbles

Description

Creates a tmap-element that draws bubbles. Both colors and sizes of the bubbles can be mapped to data variables.

Usage

tm_bubbles(size = 1, col = "blueviolet", alpha = NA, border.col = NA,
  border.lwd = 1, border.alpha = NA, scale = 1, size.lim = NA,
  sizes.legend = NULL, sizes.legend.labels = NULL, n = 5,
  style = "pretty", breaks = NULL, palette = NULL, labels = NULL,
  auto.palette.mapping = TRUE, contrast = 1, max.categories = 12,
  colorNA = "#FF1414", textNA = "Missing", xmod = 0, ymod = 0)

Arguments

size
shp data variable that determines the bubble sizes. Multiple variable names create small multiples
col
color(s) of the bubble. Either a color (vector), or categorical variable name(s). Multiple variable names create small multiples
alpha
transparency number between 0 (totally transparent) and 1 (not transparent). By default, the alpha value of the col is used (normally 1).
border.col
color of the bubble borders.
border.lwd
line width of the bubble borders. If NA (default), no bubble borders are drawn.
border.alpha
transparency number, regarding the bubble borders, between 0 (totally transparent) and 1 (not transparent). By default, the alpha value of the col is used (normally 1).
scale
bubble size multiplier number.
size.lim
vector of two limit values of the size variable. Only bubbles are drawn whose value is greater than or equal to the first value. Bubbles whose values exceed the second value are drawn at the size of the second value. Only applicable when
sizes.legend
vector of bubble sizes that are shown in the legend. By default, this is determined automatically.
sizes.legend.labels
vector of labels for that correspond to sizes.legend.
n
preferred number of color scale classes. Only applicable when col is a numeric variable name.
style
method to cut the color scale: e.g. "fixed", "equal", "pretty", "quantile", or "kmeans". See the details in classIntervals. Only applicable when col is a numeric v
breaks
in case style=="fixed", breaks should be specified
palette
color palette (see RColorBrewer::display.brewer.all) for the bubbles. 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
number between 0 and 1 (default) that determines the contrast of the palette. Only applicable when auto.palette.mapping=TRUE and col is a numeric variable name.
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
colour for missing values
textNA
text used for missing values. Use NA to omit text for missing values in the legend
xmod
horizontal position modification of the bubbles, relatively where 0 means no modification, and 1 means the total width of the frame. Either a single number for all polygons, or a numeric variable in the shape data specifying a number for each polygon. Tog
ymod
vertical position modification. See xmod.

Value

See Also

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

Examples

Run this code
data(World)
data(Europe)
data(cities)

tm_shape(World) +
    tm_fill() +
tm_shape(cities) +
    tm_bubbles("pop_max", scale=.5) +
tm_layout_World("Cities of the World")

tm_shape(Europe) +
    tm_borders() +
    tm_fill() +
tm_shape(cities) +
    tm_bubbles(size="pop_max", col="capital", size.lim=c(0, 2e7)) +
	tm_text("name", cex="pop_max", scale=2, root=3, ymod=-.015, bg.alpha=0) +
tm_layout_Europe("Metropolitan population", legend.titles=c(bubble.col="Capital"))

Run the code above in your browser using DataLab