Map layer that draws a cartogram
Usage
opt_tm_cartogram(type = "cont", itermax = 15, ...)
opt_tm_cartogram_ncont(type = "ncont", expansion = 1, inplace = FALSE, ...)
opt_tm_cartogram_dorling(type = "dorling", share = 5, itermax = 1000, ...)
tm_cartogram(
size = 1,
size.scale = tm_scale(),
size.legend = tm_legend_hide(),
size.chart = tm_chart_none(),
size.free = NA,
plot.order = tm_plot_order("size", reverse = FALSE),
options = opt_tm_cartogram(),
...
)
Arguments
- type
cartogram type, one of: "cont" for contiguous cartogram, "ncont" for non-contiguous cartogram and "dorling" for Dorling cartograms
- itermax,
maximum number of iterations (see
cartogram::cartogram_cont()
)- ...
Arguments passed on to
tm_polygons
fill,fill.scale,fill.legend,fill.chart,fill.free
Visual variable that determines the fill color. See details.
col,col.scale,col.legend,col.chart,col.free
Visual variable that determines the border color. See details.
lwd,lwd.scale,lwd.legend,lwd.chart,lwd.free
Visual variable that determines the line width. See details.
lty,lty.scale,lty.legend,lty.chart,lty.free
Visual variable that determines the line type. See details.
fill_alpha,fill_alpha.scale,fill_alpha.chart,fill_alpha.legend,fill_alpha.free
Visual variable that determines the fill color alpha transparency See details.
col_alpha,col_alpha.scale,col_alpha.legend,col_alpha.chart,col_alpha.free
Visual variable that determines the border color alpha transparency. See details.
linejoin,lineend
Line join and line end. See gpar() for details.
zindex
Map layers are drawn on top of each other. The
zindex
numbers (one for each map layer) determines the stacking order. By default the map layers are drawn in the order they are called.group
Name of the group to which this layer belongs. This is only relevant in view mode, where layer groups can be switched (see
group.control
)group.control
In view mode, the group control determines how layer groups can be switched on and off. Options:
"radio"
for radio buttons (meaning only one group can be shown),"check"
for check boxes (so multiple groups can be shown), and"none"
for no control (the group cannot be (de)selected).popup.vars
names of data variables that are shown in the popups in
"view"
mode. Set popup.vars toTRUE
to show all variables in the shape object. Set popup.vars toFALSE
to disable popups. Setpopup.vars
to a character vector of variable names to those those variables in the popups. The default (NA
) depends on whether visual variables (e.g.fill
) are used. If so, only those are shown. If not all variables in the shape object are shown.popup.format
list of formatting options for the popup values. See the argument
legend.format
for options. Only applicable for numeric data variables. If one list of formatting options is provided, it is applied to all numeric variables ofpopup.vars
. Also, a (named) list of lists can be provided. In that case, each list of formatting options is applied to the named variable.hover
name of the data variable that specifies the hover labels
id
name of the data variable that specifies the indices of the spatial features. Only used for
"view"
mode.
- expansion
factor expansion, see
cartogram::cartogram_ncont()
(argumentk
)- inplace
should each polygon be modified in its original place? (
TRUE
by default)- share
share of the bounding box filled with the larger circle (see
cartogram::cartogram_dorling()
argumentk
)- size, size.scale, size.legend, size.chart, size.free
Transformation variable that determines the size of the polygons.
- plot.order
Specification in which order the spatial features are drawn. See
tm_plot_order()
for details.- options
options passed on to the corresponding
opt_<layer_function>
function