tmap (version 2.0)

tm_facets: Small multiples

Description

Creates a tmap-element that specifies facets (small multiples). Small multiples can be created in two ways: 1) by specifying the by argument with one or two variable names, by which the data is grouped, 2) by specifying multiple variable names in any of the aesthetic argument of the layer functions (for instance, the argument col in tm_fill). This function further specifies the facets, for instance number of rows and columns, and whether the coordinate and scales are fixed or free (i.e. independent of each other).

Usage

tm_facets(by = NULL, along = NULL, as.layers = FALSE, ncol = NA,
  nrow = NA, free.coords = !as.layers, drop.units = free.coords ||
  as.layers, drop.empty.facets = TRUE, drop.NA.facets = FALSE,
  sync = !free.coords, showNA = NA, textNA = "Missing",
  free.scales = is.null(by) && is.null(along),
  free.scales.fill = free.scales, free.scales.symbol.size = free.scales,
  free.scales.symbol.col = free.scales,
  free.scales.symbol.shape = free.scales,
  free.scales.text.size = free.scales, free.scales.text.col = free.scales,
  free.scales.line.col = free.scales, free.scales.line.lwd = free.scales,
  free.scales.raster = free.scales, inside.original.bbox = FALSE,
  scale.factor = 2, drop.shapes = drop.units)

Arguments

by

data variable name by which the data is split, or a vector of two variable names to split the data by two variables (where the first is used for the rows and the second for the columns).

along

data variable name by which the data is split and plotted on separate pages. This is especially useful for animations made with tmap_animation. The along argument can be used in combination with the by argument. It is only supported in "plot" mode (so not in "view" mode).

as.layers

logical that determines whether facets are shown as different layers in "view" mode. By default FALSE, i.e. facets are drawn as small multiples.

ncol

number of columns of the small multiples grid. Not applicable if by contains two variable names.

nrow

number of rows of the small multiples grid. Not applicable if by contains two variable names.

free.coords

logical. If the by argument is specified, should each map has its own coordinate ranges? By default TRUE, unless facets are shown in as different layers (as.layers = TRUE)

drop.units

logical. If the by argument is specified, should non-selected spatial units be dropped? If FALSE, they are plotted where mapped aesthetics are regarded as missing values. Not applicable for raster shapes. By default TRUE when as.layers and/or free.coords is TRUE.

drop.empty.facets

logical. If the by argument is specified, should empty facets be dropped? Empty facets occur when the by-variable contains unused levels. When TRUE and two by-variables are specified, empty rows and columns are dropped.

drop.NA.facets

logical. If the by argument is specified, and all values of the defined aesthetic variables (e.g. col from tm_fill) for specific facets, should these facets be dropped? FALSE by default.

sync

logical. Should the navigation in view mode (zooming and panning) be synchronized? By default TRUE, unless free.coords is set to TRUE.

showNA

If the by argument is specified, should missing values of the by-variable be shown in a facet? If two by-variables are specified, should missing values be shown in an additional row and column? If NA, missing values only are shown if they exist. Similar to the useNA argument of table, where TRUE, FALSE, and NA correspond to "always", "no", and "ifany" respectively.

textNA

text used for facets of missing values.

free.scales

logical. Should all scales of the plotted data variables be free, i.e. independent of each other? Possible data variables are color from tm_fill, color and size from tm_symbols and line color from tm_lines.

free.scales.fill

logical. Should the color scale for the choropleth be free?

free.scales.symbol.size

logical. Should the symbol size scale for the symbol map be free?

free.scales.symbol.col

logical. Should the color scale for the symbol map be free?

free.scales.symbol.shape

logical. Should the symbol shape scale for the symbol map be free?

free.scales.text.size

logical. Should the text size scale be free?

free.scales.text.col

logical. Should the text color scale be free?

free.scales.line.col

Should the line color scale be free?

free.scales.line.lwd

Should the line width scale be free?

free.scales.raster

Should the color scale for raster layers be free?

inside.original.bbox

If free.coords, should the bounding box of each small multiple be inside the original bounding box?

scale.factor

Number that determines how the elements (e.g. font sizes, symbol sizes, line widths) of the small multiples are scaled in relation to the scaling factor of the shapes. The elements are scaled to the scale.factorth root of the scaling factor of the shapes. So, for scale.factor=1, they are scaled proportional to the scaling of the shapes. Since elements, especially text, are often too small to read, a higher value is recommended. By default, scale.factor=2.

drop.shapes

deprecated: renamed to drop.units

Value

tmap-element

Details

The global option limits controls the limit of the number of facets that are plotted. By default, tmap_options(limits=c(facets.plot=64, facets.view=4)). The maximum number of interactive facets is set to four since otherwise it may become very slow.

References

Tennekes, M., 2018, tmap: Thematic Maps in R, Journal of Statistical Software, 84(6), 1-39, DOI

See Also

vignette("tmap-getstarted")

Examples

# NOT RUN {
data(World, NLD_muni, NLD_prov, land, metro)

current.mode <- tmap_mode("plot") # small multiples don't work in view mode

# Facets defined by constant values
tm_shape(World) +
    tm_fill(c("forestgreen", "goldenrod")) +
tm_format("World", title=c("A green world", "A dry world"), bg.color="lightskyblue2", 
    title.position=c("left", "bottom"))

# Facets defined by multiple variables
tm_shape(World) +
    tm_polygons(c("well_being", "life_exp"),
    	style=c("pretty", "fixed"), breaks=list(NULL, c(65,70,75,80,85)),
    	palette=list("Oranges", "Purples"),
    	border.col = "black",
        title=c("Well-Being Index", "Life Expectancy")) +
tm_format("World")

# }
# NOT RUN {
tm_shape(NLD_muni) +
    tm_fill(c("pop_0_14", "pop_15_24", "pop_25_44", "pop_45_64", "pop_65plus"),
        style="kmeans", 
        palette=list("Oranges", "Greens", "Blues", "Purples", "Greys"),
        title=c("Population 0 to 14", "Population 15 to 24", "Population 25 to 44",
            "Population 45 to 64", "Population 65 and older")) +
tm_shape(NLD_prov) +
    tm_borders() +
tm_format("NLD", frame = TRUE, asp=0)
# }
# NOT RUN {
# Facets defined by groupings
tm_shape(NLD_prov) +
    tm_polygons("gold2") +
    tm_facets(by="name")

# }
# NOT RUN {
tm_shape(NLD_muni) +
    tm_borders() +
    tm_facets(by="province") +
    tm_fill("population", style="kmeans", convert2density = TRUE) +
tm_shape(NLD_prov) +
    tm_borders(lwd=4) +
    tm_facets(by="name")

tm_shape(land) +
    tm_raster("black") +
    tm_facets(by="cover_cls")
# }
# NOT RUN {
	
# Facets defined by groupings defined by two variables
# }
# NOT RUN {
World$HPI3 <- cut(World$HPI, breaks = c(20, 35, 50, 65), 
    labels = c("HPI low", "HPI medium", "HPI high"))
World$GDP3 <- cut(World$gdp_cap_est, breaks = c(0, 5000, 20000, Inf), 
    labels = c("GDP low", "GDP medium", "GDP high"))

tm_shape(World) + 
	tm_fill("HPI3", palette="Dark2", colorNA="grey90", legend.show = FALSE) + 
	tm_facets(c("HPI3", "GDP3"), showNA=FALSE, free.coords = FALSE)

metro$pop1950cat <- cut(metro$pop1950, breaks=c(0.5, 1, 1.5, 2, 3, 5, 10, 40)*1e6)
metro$pop2020cat <- cut(metro$pop2020, breaks=c(0.5, 1, 1.5, 2, 3, 5, 10, 40)*1e6)

tm_shape(World) +
	tm_fill() +
tm_shape(metro) +
tm_dots("red", size = .5) +
	tm_facets(c("pop1950cat", "pop2020cat"), free.coords = FALSE) +
tm_layout(panel.label.rot = c(0, 90), panel.label.size = 2)
# }
# NOT RUN {
# restore current mode
tmap_mode(current.mode)
# }