tmap_style: Set or get the default tmap style

View source: R/tmap_style.R

tmap_styleR Documentation

Set or get the default tmap style

Description

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.

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 a new style is created.

Value

the style before changing

See Also

tmap_options for tmap options, and tmap_style_catalogue to create a style catalogue of all available styles.

Examples

data(World)

current.style <- tmap_style("classic")
qtm(World, fill="life_exp", fill.title="Life expectancy")

tmap_style("cobalt")
qtm(World, fill="life_exp", fill.title="Life expectancy")

# restore current style
tmap_style(current.style)

tmap documentation built on March 18, 2022, 5:23 p.m.