Skip to contents

Set or get the default tmap style

Source: R/tmap_style.R
tmap_style.Rd

Set or get the default tmap style. Without arguments, the current style is returned. Also the available styles are displayed. When a style is set, the corresponding tmap options (see tmap_options()) will be set accordingly. The default style (i.e. when loading the package) is "white".

Usage

tmap_style(style)

Arguments

style

Name of the style. When omitted, tmap_style() returns the current style and also shows all available styles. When the style is specified,tmap_style() sets the style accordingly. Note that in that case, all tmap options (see tmap_options()) will be reset according to the style definition. See tm_layout() for predefined styles, and tmap_style_catalogue() for creating a catalogue. Styles can be combined, e.g. c("cobalt", "v4.4"), where the options of later styles take precedence. See details for the styles of previous tmap versions.

Value

The style before changing

Details

Note that tm_style() is used within a plot call (so it only affects that plot), whereas tmap_style() sets the style globally.

After loading a style, the options that defined this style (i.e. the difference with the default "white" style) can be obtained by tmap_options_diff().

The documentation of tmap_options() (details and the examples) shows how to create a new style.

For backward compatibility, there are also styles of previous tmap versions:

  • "v4.4": the numeric scales of tmap 4.0 to 4.4. In tmap 4.5, these scales were made consistent: the classes of a numeric map variable that starts at 0 (such as size and lwd) no longer start at 0, and continuous scales use the same values as the other scales (so data-driven line widths range from 0 to 3 instead of from 0 to 1). This style reproduces the maps of tmap 4.0 to 4.4. It can be combined with other styles, e.g. tm_style(c("cobalt", "v4.4")).

  • "v3" and "<style>_v3", e.g. "cobalt_v3": the styles of tmap 3, which also include the numeric scales of "v4.4".

See also

Examples

tmap_style()
#> current tmap style is "white" (tmap default)
#> other available styles are: "gray", "natural", "cobalt", "albatross", "beaver", "bw", "classic", "watercolor", "fancy"
#> styles of previous tmap versions: "v4.4" (numeric scales of tmap 4.0-4.4), "v3" (tmap v3 default), "gray_v3", "natural_v3", "cobalt_v3", "albatross_v3", "beaver_v3", "bw_v3", "classic_v3", "watercolor_v3"

tm_shape(World) + tm_polygons("HPI")


tmap_style("cobalt")
#> style set to "cobalt"
#> other available styles are: "white" (tmap default), "gray", "natural", "albatross", "beaver", "bw", "classic", "watercolor", "fancy"
#> styles of previous tmap versions: "v4.4" (numeric scales of tmap 4.0-4.4), "v3" (tmap v3 default), "gray_v3", "natural_v3", "cobalt_v3", "albatross_v3", "beaver_v3", "bw_v3", "classic_v3", "watercolor_v3"

tm_shape(World) + tm_polygons("HPI")


# for backwards compatibility, the styles of tmap versions 1-3 are also included:

tmap_style("v3")
#> style set to "v3" (tmap v3 default)
#> other available styles are: "white" (tmap default), "gray", "natural", "cobalt", "albatross", "beaver", "bw", "classic", "watercolor", "fancy"
#> styles of previous tmap versions: "v4.4" (numeric scales of tmap 4.0-4.4), "gray_v3", "natural_v3", "cobalt_v3", "albatross_v3", "beaver_v3", "bw_v3", "classic_v3", "watercolor_v3"

tm_shape(World) + tm_polygons("HPI")


tmap_style("cobalt_v3")
#> style set to "cobalt_v3"
#> other available styles are: "white" (tmap default), "gray", "natural", "cobalt", "albatross", "beaver", "bw", "classic", "watercolor", "fancy"
#> styles of previous tmap versions: "v4.4" (numeric scales of tmap 4.0-4.4), "v3" (tmap v3 default), "gray_v3", "natural_v3", "albatross_v3", "beaver_v3", "bw_v3", "classic_v3", "watercolor_v3"

tm_shape(World) + tm_polygons("HPI")


# the numeric scales of tmap 4.0 to 4.4 (here: thinner data-driven line widths)
tmap_style("white")
#> style set to "white" (tmap default)
#> other available styles are: "gray", "natural", "cobalt", "albatross", "beaver", "bw", "classic", "watercolor", "fancy"
#> styles of previous tmap versions: "v4.4" (numeric scales of tmap 4.0-4.4), "v3" (tmap v3 default), "gray_v3", "natural_v3", "cobalt_v3", "albatross_v3", "beaver_v3", "bw_v3", "classic_v3", "watercolor_v3"

tm_shape(World_rivers) + tm_lines(lwd = "strokelwd")


tm_shape(World_rivers) + tm_lines(lwd = "strokelwd") + tm_style("v4.4")


# styles can be combined
tm_shape(World_rivers) + tm_lines(lwd = "strokelwd") + tm_style(c("cobalt", "v4.4"))