Package 'geovizr'

Description

Create a wide range of interactive, zoomable vector maps. This package is an R binding for the geoviz javascript library (https://github.com/riatelab/geoviz), itself based on the d3.js ecosystem ported by Mike Bostock (https://d3js.org/). Like the original javascript library, the package takes advantage of d3's many features: proportional symbols, pictograms, typologies, choropleth maps, Spikes, tiles, Dorling cartograms, etc. It can also be used to create pretty static vectorial maps in svg format, suitable for editorial cartography.

Author(s)

Maintainer: Nicolas Lambert [email protected] (ORCID)

Authors:

• Nicolas Lambert [email protected] (ORCID)

Other contributors:

• Timothée Giraud [email protected] (ORCID) [contributor]

See Also

Useful links:

• https://riatelab.github.io/geovizr/

• Report bugs at https://github.com/riatelab/geovizr/issues/

Description

The viz_blur function creates an SVG blur filter and adds it to the map definitions. It returns a reference usable in SVG styling (e.g. url(#id)).

Usage

viz_blur(map, id = NULL, stdDeviation = 1.5, ...)

Arguments

Value

A modified 'geoviz' map object with a new effect added. Rendering is performed using viz_render()

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)
aus <- world[world$ISO3 == "AUS", ]

viz_create(margin = 5, width = 650) |>
  viz_blur(id = "my_blur_effect", stdDeviation = 2) |>
  viz_path(datum = aus, fill = "#38896F", filter = "url(#my_blur_effect)") |>
  viz_render()

Description

The viz_choro function creates a choropleth map from a spatial data frame by classifying a numeric variable and mapping it to a color palette. It supports multiple classification methods and automatic legend generation.

Usage

viz_choro(
  map,
  data = NULL,
  var,
  method = "quantile",
  nb = 6,
  breaks = NULL,
  colors = NULL,
  middle = FALSE,
  sd = 1,
  reverse = FALSE,
  missing = "white",
  legend = TRUE,
  leg_type = "vertical",
  leg_pos = c(10, 10),
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(
  projection = "EqualEarth", background = "white",
  zoomable = TRUE
) |>
  viz_choro(
    data = world, var = "gdppc", method = "quantile", nb = 5,
    leg_values_round = 0, leg_title = "GDP\nper\ncapita",
    leg_subtitle = "(in $/inh.)", colors = "PinkYl"
  ) |>
  viz_render()

Description

The viz_circle function draws circles on the map from a spatial data frame or from a single position. It can be used to create proportional symbol maps with optional collision avoidance.

Usage

viz_circle(
  map,
  data = NULL,
  id = NULL,
  pos = c(0, 0),
  r = 10,
  k = 50,
  fixmax = NULL,
  dodge = FALSE,
  iteration = 200,
  sort = NULL,
  descending = NULL,
  coords = "geo",
  fill = NULL,
  stroke = "white",
  tip = FALSE,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_circle(data = world, r = 30, fill = "#38896F") |>
  viz_render()

Description

The viz_clipPath function creates an SVG clipPath definition and adds it to the SVG defs. It returns a reference usable in SVG styling (e.g. url(#id)). WARNING: the clipPath is global to the web page, not only the map.

Usage

viz_clipPath(map, id = NULL, datum = list(type = "Sphere"), permanent = FALSE)

Arguments

Value

A modified 'geoviz' map object with a new effect added. Rendering is performed using viz_render()

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)
aus <- world[world$ISO3 == "AUS", ]

viz_create(margin = 5, projection = "meractor") |>
  viz_clipPath(id = "ausclip", datum = aus) |>
  viz_tile(url = "worldStreet", clipPath = "url(#ausclip)") |>
  viz_render()

Description

The viz_create function initializes a geovizr map by creating an SVG container and defining its main configuration (projection, domain, size, margins, and layout). It is the first step in any map construction workflow.

Usage

viz_create(
  id = "map",
  width = NULL,
  resize = TRUE,
  domain = NULL,
  responsive = TRUE,
  projection = NULL,
  background = NULL,
  fontFamily = NULL,
  margin = c(0, 0, 0, 0),
  zoomable = NULL,
  control = TRUE,
  warning = TRUE
)

Arguments

Value

A list containing map parameters and an initially empty list of layers to be displayed.

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", zoomable = TRUE) |>
  viz_path(data = world, fill = "#38896F") |>
  viz_render()

Description

The viz_dotdensity function creates a dot density map by distributing points proportionally to a numeric variable. Each dot represents a fixed quantity of the underlying data.

Usage

viz_dotdensity(
  map,
  data = NULL,
  var,
  stroke = "none",
  r = 1,
  dotval = NULL,
  fill = "black",
  legend = TRUE,
  leg_pos = NULL,
  leg_text = NULL,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)
cities <- st_read(
  system.file("gpkg/cities.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_dotdensity(data = cities, var = "population") |>
  viz_render()

Description

The viz_earth function displays PNG images representing the Earth's surface (Natural Earth dataset or custom source). The image is projected on-the-fly. The images are hosted on GitHub. You will need an internet connection. This function is only relevant at the world scale.

Usage

viz_earth(
  map,
  id = NULL,
  url = "NE2_50M_SR_W",
  resolution = 1,
  tileSize = 1024,
  opacity = 1,
  dx = 0,
  dy = 0,
  clipPath = NULL,
  max_canvas_size = NULL
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

viz_create(projection = "EqualEarth", background = "white") |>
  viz_earth(url = "NE2_50M_SR_W", resolution = 2) |>
  viz_render()

Description

The viz_footer function adds a text below a geoviz map.

Usage

viz_footer(
  map,
  id = NULL,
  text = "Author, source...",
  fill = "#9e9696",
  background_fill = "white",
  background_stroke = "white",
  background_strokeWidth = 1,
  dominantBaseline = "central",
  textAnchor = "middle",
  lineSpacing = 0,
  margin = 1,
  fontSize = 10,
  fontFamily = NULL,
  dx = 0,
  dy = 0,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_footer(text = "Source, author, note, etc.", fill = "#38896F") |>
  viz_render()

Description

The viz_graticule function draws a graticule (latitude and longitude lines) on the map. The spacing between lines can be uniform or specified separately for parallels and meridians.

Usage

viz_graticule(
  map,
  id = NULL,
  step = 10,
  stroke = "#9ad5e6",
  fill = "none",
  strokeWidth = 0.8,
  strokeLinecap = "square",
  strokeLinejoin = "round",
  strokeDasharray = 2,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_graticule(step = c(10, 20), stroke = "#38896F") |>
  viz_render()

Description

The gridchoro function builds a choropleth map based on a spatial grid aggregation. It first generates a grid from the input spatial data frame, aggregates values within each cell, and maps them using a color classification.

Usage

viz_gridchoro(
  map,
  data = NULL,
  var,
  grid = "square",
  step = 15,
  level = 1,
  ratio_factor = 1,
  coords = "geo",
  missing = "white",
  fixmax = NULL,
  legend = TRUE,
  leg_type = "vertical",
  leg_pos = c(10, 10),
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)
cities <- st_read(
  system.file("gpkg/cities.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_gridchoro(data = cities, var = "population") |>
  viz_render()

Description

The viz_gridprop function builds a proportional symbol map aggregated on a spatial grid. It first generates a grid from the input spatial data frame, then displays aggregated values within each cell using proportional symbols.

Usage

viz_gridprop(
  map,
  data = NULL,
  var,
  grid = "square",
  step = 15,
  level = 1,
  coords = "geo",
  missing = "white",
  symbol = "circle",
  k = 10,
  width = 30,
  straight = 0,
  fixmax = NULL,
  legend = TRUE,
  leg_type = "separate",
  leg_pos = c(10, 10),
  leg_title = NULL,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)
cities <- st_read(
  system.file("gpkg/cities.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_gridprop(data = cities, var = "population") |>
  viz_render()

Description

The viz_halfcircle function draws rotatable half-circles on the map from a spatial data frame or from a single position. It can be used to represent values with semi-circular proportional symbols.

Usage

viz_halfcircle(
  map,
  data = NULL,
  id = NULL,
  pos = c(0, 0),
  dx = 0,
  dy = 0,
  angle = 0,
  r = 10,
  innerRadius = 0,
  cornerRadius = 2,
  k = 50,
  fixmax = NULL,
  sort = NULL,
  descending = NULL,
  coords = "geo",
  fill = NULL,
  stroke = NULL,
  tip = FALSE,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_halfcircle(data = world, r = 30, fill = "#38896F") |>
  viz_render()

Description

The viz_header function adds a title above a geoviz map.

Usage

viz_header(
  map,
  id = NULL,
  text = "Map title",
  fill = "#9e9696",
  background_fill = "white",
  background_stroke = "white",
  background_strokeWidth = 1,
  dominantBaseline = "central",
  textAnchor = "middle",
  lineSpacing = 0,
  margin = 8,
  fontSize = 26,
  fontFamily = NULL,
  dx = 0,
  dy = 0,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_header(text = "Hello World", fill = "#38896F") |>
  viz_render()

Description

The viz_leg_box function creates a box legend. The function adds a legend layer to the map.

Usage

viz_leg_box(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  rect_width = 25,
  rect_height = 17,
  rect_fill = "#5d6266",
  rect_stroke = "#303030",
  rect_strokeWidth = 0.1,
  label = "",
  label_fill = "#363636",
  label_fontSize = 10,
  label_dx = 5,
  label_dominantBaseline = "central",
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_box(pos = c(20, 20), label = "Hello") |>
  viz_render()

Description

The viz_leg_choro_horizontal function creates a horizontal legend for choropleth layers. The function adds a legend layer to the map.

Usage

viz_leg_choro_horizontal(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  breaks = c(1, 2, 3, 4, 5),
  colors = c("#fee5d9", "#fcae91", "#fb6a4a", "#cb181d"),
  rect_width = 50,
  rect_height = 14,
  rect_spacing = 0,
  rect_fill = "#5d6266",
  rect_stroke = "#303030",
  rect_strokeWidth = 0.1,
  values_textAnchor = "middle",
  values_dx = 0,
  values_dy = 5,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_choro_horizontal(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_choro_vertical function creates a vertical legend for choropleth layers. The function adds a legend layer to the map.

Usage

viz_leg_choro_vertical(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  breaks = c(1, 2, 3, 4, 5),
  colors = c("#fee5d9", "#fcae91", "#fb6a4a", "#cb181d"),
  rect_width = 25,
  rect_height = 17,
  rect_spacing = 0,
  rect_fill = "#5d6266",
  rect_stroke = "#303030",
  rect_strokeWidth = 0.1,
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_choro_vertical(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_circles function adds a legend for proportional circles. It draws circles scaled by values, with optional reference lines and labels. The function adds a legend layer to the SVG container.

Usage

viz_leg_circles(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  data = c(1, 1000),
  k = 50,
  fixmax = NULL,
  nb = 4,
  circle_fill = "none",
  circle_stroke = "#363636",
  circle_spacing = 5,
  line_stroke = "#363636",
  line_strokeDasharray = "1",
  line_strokeWidth = 0.7,
  line_length = 10,
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_circles(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_circles_nested function adds a legend for nested proportional circles. It displays circles with hierarchical/nested visual structure for comparative values. The function adds a legend layer to the SVG container.

Usage

viz_leg_circles_nested(
  map,
  id = NULL,
  pos = c(0, 5),
  gap = 2,
  data = c(1, 1000),
  k = 50,
  fixmax = NULL,
  nb = 4,
  circle_fill = "none",
  circle_stroke = "#363636",
  line_stroke = "#363636",
  line_strokeDasharray = "1",
  line_strokeWidth = 0.7,
  line_length = 10,
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_circles_nested(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_gradient_vertical function creates a vertical gradient legend. It draws a series of colored rectangles with three labels aligned at top, middle, and bottom. The function adds a legend layer to the map.

Usage

viz_leg_gradient_vertical(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 5,
  colors = c("#fee5d9", "#fcae91", "#fb6a4a", "#cb181d"),
  rect_width = 8,
  rect_height = 25,
  rect_spacing = 0,
  rect_stroke = "white",
  values_fontSize = 12,
  values_fill = "black",
  text_high = "High",
  text_intermediate = "Intermediate",
  text_low = "Low",
  reverse = FALSE,
  frame = FALSE,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_gradient_vertical(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_mushrooms function adds a legend for proportional half-circles. It displays two sets of nested half-circles (top and bottom), each scaled according to input values. The function adds a legend layer to the SVG container and returns the layer identifier.

Usage

viz_leg_mushrooms(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  line_stroke = "#363636",
  line_strokeDasharray = "1",
  line_strokeWidth = 0.7,
  line_length = 10,
  top_data = NULL,
  top_k = 50,
  top_fixmax = NULL,
  top_nb = 4,
  top_circle_fill = "none",
  top_circle_stroke = "black",
  top_circle_cornerRadius = 5,
  top_values_textAnchor = "start",
  top_values_dx = 5,
  top_values_dy = 0,
  top_values_factor = 1,
  top_values_decimal = ".",
  top_values_thousands = " ",
  top_title = "top_title",
  bottom_data = NULL,
  bottom_k = 50,
  bottom_fixmax = NULL,
  bottom_nb = 4,
  bottom_circle_fill = "none",
  bottom_circle_stroke = "black",
  bottom_circle_cornerRadius = 5,
  bottom_values_textAnchor = "start",
  bottom_values_dx = 5,
  bottom_values_dy = 0,
  bottom_values_factor = 1,
  bottom_values_decimal = ".",
  bottom_values_thousands = " ",
  bottom_title = "bottom_title",
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_mushrooms(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_spikes function adds a legend for spike marks. It draws a series of spikes with heights proportional to values. The function adds a legend layer to the SVG container.

Usage

viz_leg_spikes(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  data = c(1, 1000),
  k = 50,
  fixmax = NULL,
  nb = 4,
  spike_width = 30,
  spike_straight = 0,
  spike_spacing = 3,
  spike_fill = "none",
  spike_stroke = "black",
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_spikes(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_squares function adds a legend for proportional squares. It displays squares scaled according to input values, optionally comparable via fixmax. The function adds a legend layer to the SVG container.

Usage

viz_leg_squares(
  map,
  id = NULL,
  pos = c(0, 0),
  data = c(1, 1000),
  gap = 2,
  k = 50,
  fixmax = NULL,
  nb = 4,
  square_fill = "none",
  square_stroke = "#363636",
  square_spacing = 5,
  line_stroke = "#363636",
  line_strokeDasharray = "1",
  line_strokeWidth = 0.7,
  line_length = 10,
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_squares(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_squares_nested function adds a legend for proportional nested squares. It displays squares scaled according to input values, optionally comparable via fixmax. The function adds a legend layer to the SVG container.

Usage

viz_leg_squares_nested(
  map,
  id = NULL,
  pos = c(0, 5),
  gap = 2,
  data = c(1, 1000),
  k = 50,
  fixmax = NULL,
  nb = 4,
  square_fill = "none",
  square_stroke = "#363636",
  square_spacing = 5,
  line_stroke = "#363636",
  line_strokeDasharray = "1",
  line_strokeWidth = 0.7,
  line_length = 10,
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  values_factor = 1,
  values_decimal = ".",
  values_thousands = " ",
  title = "",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_squares_nested(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_symbol_horizontal function adds a horizontal legend for symbol layers. It displays a set of categorized symbols with optional shapes and ordering. The function creates a legend layer in the SVG container and returns the layer identifier.

Usage

viz_leg_symbol_horizontal(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  types = c("A", "B", "C", "D"),
  symbols = c("circle", "square", "triangle", "pentagon"),
  alphabetical = TRUE,
  symbol_size = 10,
  symbol_rotate = 0,
  symbol_spacing = 4,
  symbol_fill = "#2e2e2e",
  symbol_stroke = "#303030",
  symbol_strokeWidth = 0.5,
  symbol_background = FALSE,
  values_textAnchor = "middle",
  values_dx = 0,
  values_dy = 5,
  values_fill = "#363636",
  values_fontSize = 10,
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_symbol_horizontal(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_symbol_vertical function adds a vertical legend for symbol layers. It displays categorized symbols arranged vertically with optional shapes and ordering. The function creates a legend layer in the SVG container and returns the layer identifier.

Usage

viz_leg_symbol_vertical(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  types = c("A", "B", "C", "D"),
  symbols = c("circle", "square", "triangle", "pentagon"),
  alphabetical = TRUE,
  symbol_size = 10,
  symbol_rotate = 0,
  symbol_spacing = 4,
  symbol_fill = "#2e2e2e",
  symbol_stroke = "#303030",
  symbol_strokeWidth = 0.5,
  symbol_background = FALSE,
  values_textAnchor = "middle",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)

world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_symbol_vertical(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_typo_horizontal function creates a horizontal legend for typology layers. The function adds a legend layer to the map.

Usage

viz_leg_typo_horizontal(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  types = c("A", "B", "C", "D"),
  colors = c("#e41a1c", "#377eb8", "#4daf4a", "#984ea3"),
  alphabetical = TRUE,
  rect_width = 50,
  rect_height = 14,
  rect_spacing = 0,
  rect_fill = "#5d6266",
  rect_stroke = "#303030",
  rect_strokeWidth = 0.1,
  values_textAnchor = "middle",
  values_dx = 0,
  values_dy = 5,
  values_fill = "#363636",
  values_fontSize = 10,
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_typo_horizontal(pos = c(20, 20)) |>
  viz_render()

Description

The viz_leg_typo_vertical function creates a vertical legend for typology layers. The function adds a legend layer to the map.

Usage

viz_leg_typo_vertical(
  map,
  id = NULL,
  pos = c(0, 0),
  gap = 2,
  types = c("A", "B", "C", "D"),
  colors = c("#e41a1c", "#377eb8", "#4daf4a", "#984ea3"),
  alphabetical = TRUE,
  rect_width = 25,
  rect_height = 17,
  rect_spacing = 3,
  rect_fill = "#5d6266",
  rect_stroke = "#303030",
  rect_strokeWidth = 0.1,
  values_textAnchor = "start",
  values_dx = 5,
  values_dy = 0,
  values_fill = "#363636",
  values_fontSize = 10,
  title = "Legend",
  title_fill = "#363636",
  title_fontSize = 16,
  subtitle = "",
  subtitle_fill = "#363636",
  subtitle_fontSize = 12,
  note = "",
  note_fill = "#363636",
  note_fontSize = 10,
  frame = FALSE,
  frame_margin = 15,
  frame_fill = "white",
  frame_stroke = "black",
  frame_fillOpacity = 0.5,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_leg_typo_vertical(pos = c(20, 20)) |>
  viz_render()

Description

The viz_minimap function adds a minimap inset to a geoviz map. It displays a basemap and optionally highlights a location geometry (polygon or point). This is useful for showing spatial context in map layouts. NB: The map’s projection must provide an invert() function.

Usage

viz_minimap(
  map,
  id = NULL,
  basemap_data = NULL,
  basemap_fill = "white",
  basemap_fillOpacity = 0.5,
  basemap_stroke = "none",
  width = 200,
  projection = "EqualEarth",
  precision = 10,
  pos = c(10, 10),
  location_type = "polygon",
  location_r = 5,
  location_fill = NULL,
  location_stroke = NULL,
  location_strokeWidth = 1.2,
  domain = NULL,
  margin = NULL,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)
afr <- world[world$region == "Africa", ]
viz_create(projection = "Mercator", background = "white", domain = afr) |>
  viz_path(data = world, fill = "#9e9696") |>
  viz_minimap(
    width = 200,
    projection = "EqualEarth",
    pos = c(20, 20),
    location_stroke = "red"
  ) |>
  viz_render()

Description

The viz_north function adds a north arrow a geoviz map.

Usage

viz_north(
  map,
  id = NULL,
  pos = NULL,
  scale = 1,
  rotate = NULL,
  fill = "black",
  fillOpacity = 1,
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "Mercator", background = "white") |>
  viz_path(datum = world[world$region == "Africa", ], fill = "#f1f3f5") |>
  viz_north(fill = "#38896F") |>
  viz_render()

Description

The viz_outline function draws the Earth outline according to the current map projection. This layer can be used as a background or clipping reference.

Usage

viz_outline(
  map,
  id = NULL,
  stroke = "none",
  strokeWidth = 1,
  fill = "#B5DFFD",
  ...
)

Arguments

Value

A modified 'geoviz' map object with a new layer added. Rendering is performed using viz_render().

Examples

library(sf)
world <- st_read(
  system.file("gpkg/world.gpkg", package = "geovizr"),
  quiet = TRUE
)

viz_create(projection = "EqualEarth", background = "white") |>
  viz_path(datum = world, fill = "#f1f3f5") |>
  viz_outline(fill = "#38896F") |>
  viz_render()

Description

The viz_path function draws geometries from a spatial data frame as SVG paths. This function can be used to display polygons, lines, or points, and supports styling, simplification, and interaction.

Usage

viz_path(
  map,
  data = NULL,
  datum = NULL,
  id = NULL,
  coords = "geo",
  clip = TRUE,
  fill = NULL,
  stroke = NULL,
  strokeWidth = 1,
  tip = FALSE,
  simplify = FALSE,
  rewind = FALSE,
  rewindPole = FALSE,
  clipOutline = 0,
  r = 3,
  ...
)

Arguments