Add a circle layer

Description

Adds a GPU-rendered circle layer (points). Use formulas (e.g. ~mag * 2) to map columns to aesthetics.

Usage

add_circles(
  map,
  data = NULL,
  lon = NULL,
  lat = NULL,
  color = "darkblue",
  opacity = 1,
  width = 1,
  fill_color = "dodgerblue",
  fill_opacity = 0.8,
  radius = 6,
  stroke = TRUE,
  tooltip = NULL,
  popup = NULL,
  id = NULL,
  group = NULL,
  pickable = TRUE,
  radius_units = c("pixels", "meters", "common"),
  radius_min_pixels = NULL,
  radius_max_pixels = NULL,
  width_units = c("pixels", "meters", "common"),
  width_min_pixels = NULL,
  width_max_pixels = NULL
)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d, radius = ~value, fill_color = "dodgerblue")

Add filters to a layer

Description

Registers one or more filters for a layer. When multiple layers share the same bind, controls merge across layers by (bind, label, type).

Usage

add_filters(map, ..., id = NULL, bind = NULL, position = NULL, layer_id = NULL)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d) |>
  add_filters(
    filter_range(~value, default = c(4, 6)),
    bind = "filters"
  )

Add MapLibre fullscreen control

Description

Add MapLibre fullscreen control

Usage

add_fullscreen(map, position = "topright", ...)

Arguments

Value

The modified map widget.

Examples

maplamina() |>
  add_fullscreen()

Add MapLibre geolocate control

Description

Add MapLibre geolocate control

Usage

add_geolocate(map, position = "topright", track_user_location = FALSE, ...)

Arguments

Value

The modified map widget.

Examples

maplamina() |>
  add_geolocate()

Add an icon layer

Description

Adds a point icon layer. Icons are referenced by id (resolved in the frontend icon set).

Usage

add_icons(
  map,
  data = NULL,
  lon = NULL,
  lat = NULL,
  icon = "marker",
  size = 18,
  color = "#3388ff",
  opacity = 1,
  tooltip = NULL,
  popup = NULL,
  id = NULL,
  group = NULL,
  pickable = TRUE,
  size_units = c("pixels", "meters", "common"),
  size_min_pixels = NULL,
  size_max_pixels = 64,
  icon_anchor = NULL,
  mask = TRUE,
  occlude = FALSE
)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_icons(d, icon = "star", size = 20)

Add a legend component

Description

Adds a categorical or continuous legend. Legends can be conditionally displayed based on layer/view, and can be mounted via the panel by bind.

Usage

add_legend(
  map,
  title = NULL,
  type = c("categorical", "continuous"),
  position = c("bottomleft", "bottomright", "topleft", "topright"),
  values = NULL,
  colors = NULL,
  shapes = "square",
  sizes = NULL,
  range = NULL,
  labels = NULL,
  breaks = NULL,
  gradient = NULL,
  shape = "square",
  size = 12,
  layer = NULL,
  view = NULL,
  bind = NULL,
  id = NULL
)

Arguments

Value

The modified map widget.

Examples

maplamina() |>
  add_legend(
    title = "Magnitude",
    type = "continuous",
    range = c(3, 7),
    gradient = c("lightyellow", "red")
  )

Add a line layer

Description

Adds a GPU-rendered line/path layer.

Usage

add_lines(
  map,
  data = NULL,
  color = "#3388ff",
  opacity = 1,
  width = 1,
  tooltip = NULL,
  popup = NULL,
  id = NULL,
  group = NULL,
  pickable = TRUE,
  width_units = c("pixels", "meters", "common"),
  width_min_pixels = NULL,
  width_max_pixels = NULL
)

Arguments

Value

The modified map widget.

Examples

if (requireNamespace("sf", quietly = TRUE)) {
  ln <- sf::st_sfc(
    sf::st_linestring(matrix(c(-122.4, 37.8, -122.5, 37.85), ncol = 2, byrow = TRUE)),
    crs = 4326
  )
  ln <- sf::st_sf(id = 1, geometry = ln)

  maplamina(ln) |>
    add_lines(color = "black", width = 3)
}

Add a marker layer

Description

Convenience wrapper around add_icons() using the default marker icons.

Usage

add_markers(
  map,
  data = NULL,
  lon = NULL,
  lat = NULL,
  size = 18,
  color = "dodgerblue",
  opacity = 1,
  tooltip = NULL,
  popup = NULL,
  id = NULL,
  group = NULL,
  pickable = TRUE,
  size_units = c("pixels", "meters", "common"),
  size_min_pixels = NULL,
  size_max_pixels = NULL
)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_markers(d, size = ~value * 3)

Add MapLibre navigation controls

Description

Adds zoom buttons and/or compass control.

Usage

add_navigation(
  map,
  position = "topright",
  compass = TRUE,
  zoom_controls = TRUE,
  ...
)

Arguments

Value

The modified map widget.

Examples

maplamina() |>
  add_navigation(position = "topright", compass = FALSE)

Add a global, presentation-only panel

Description

The panel mounts previously-declared controls by bind id (see section() and sections()).

Usage

add_panel(
  map,
  title = NULL,
  description = NULL,
  icon = NULL,
  dividers = TRUE,
  position = NULL,
  sections = NULL
)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d) |>
  add_filters(filter_range(~value), bind = "filters") |>
  add_panel(sections = sections(section("filters")))

Add a polygon layer

Description

Adds a polygon layer (fill + optional stroke). For data-driven fills, use a color scale spec such as color_quantile() or color_factor().

Usage

add_polygons(
  map,
  data = NULL,
  color = "darkblue",
  opacity = 1,
  width = 1,
  fill_color = "dodgerblue",
  fill_opacity = 0.6,
  stroke = TRUE,
  elevation = NULL,
  elevation_scale = 1,
  tooltip = NULL,
  popup = NULL,
  id = NULL,
  group = NULL,
  pickable = TRUE,
  width_units = c("pixels", "meters", "common"),
  width_min_pixels = NULL,
  width_max_pixels = NULL
)

Arguments

Value

The modified map widget.

Examples

if (requireNamespace("sf", quietly = TRUE)) {
  nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"), quiet = TRUE)
  maplamina(nc) |>
    add_polygons(fill_color = color_quantile(~BIR74), stroke = FALSE)
}

Add MapLibre scale bar

Description

Add MapLibre scale bar

Usage

add_scalebar(
  map,
  position = "bottomleft",
  unit = c("metric", "imperial", "nautical"),
  max_width = 100,
  ...
)

Arguments

Value

The modified map widget.

Examples

maplamina() |>
  add_scalebar(unit = "metric")

Add summaries to a layer

Description

Registers one or more summary rows that update with filtering. When multiple layers share the same bind, a single summaries card can be created.

Usage

add_summaries(
  map,
  ...,
  id = NULL,
  bind = NULL,
  position = NULL,
  layer_id = NULL
)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d) |>
  add_filters(filter_range(~value), bind = "filters") |>
  add_summaries(summary_mean(~value, label = "Avg value"), bind = "summaries") |>
  add_panel(sections = sections(section("filters"), section("summaries")))

Add views to a layer

Description

Registers a per-layer views component. When multiple layers share the same bind, a single selector control is created.

Usage

add_views(
  map,
  ...,
  id = NULL,
  bind = NULL,
  position = NULL,
  layer_id = NULL,
  duration = 750,
  easing = c("smoothstep", "linear", "easein", "easeout", "easeinout", "easeInOutCubic")
)

Arguments

Value

The modified map widget.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d, radius = 5) |>
  add_views(
    view("magnitude", radius = ~value * 3),
    view("faint", fill_opacity = 0.2)
  )

Basemap tile styles

Description

A named list of MapLibre-compatible style URLs for common open-source basemaps. Pass any entry directly to the style argument of maplamina.

Usage

base_tiles

Format

A named list of character strings (URLs).

carto_positron

Light basemap with labels. Good default for thematic maps.

carto_positron_nolabels

Light basemap without labels. Clean background for dense data.

carto_dark_matter

Dark basemap with labels. Good for glowing point layers.

carto_dark_matter_nolabels

Dark basemap without labels.

carto_voyager

Colored basemap with labels. More geographic detail than Positron.

carto_voyager_nolabels

Colored basemap without labels.

openfreemap_liberty

OSM Liberty style hosted by OpenFreeMap. No API key required.

openfreemap_bright

OSM Bright style hosted by OpenFreeMap. No API key required.

openfreemap_positron

Positron style hosted by OpenFreeMap. No API key required.

demotiles

MapLibre demo tiles. Lightweight, no API key, useful for testing.

Examples

# Polygons example (sf ships the nc shapefile)
if (requireNamespace("sf", quietly = TRUE)) {
  nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"), quiet = TRUE)

  maplamina(nc) |>
    add_polygons(fill_color = color_quantile(~BIR74), stroke = FALSE)

  maplamina(nc, style = base_tiles$carto_dark_matter) |>
    add_polygons(fill_color = color_quantile(~BIR74, "Inferno"), stroke = FALSE)
}

Binned (equal-interval or manual breaks) color scale specification

Description

Binned (equal-interval or manual breaks) color scale specification

Usage

color_bin(
  expr,
  palette = NULL,
  bins = 5,
  domain = NULL,
  na_color = "#00000000",
  reverse = FALSE,
  clamp = TRUE
)

Arguments

Value

A color scale specification object.

Categorical color scale specification

Description

Categorical color scale specification

Usage

color_factor(
  expr,
  palette = NULL,
  domain = NULL,
  na_color = "#00000000",
  reverse = FALSE
)

Arguments

Value

A color scale specification object.

Continuous color scale specification

Description

Creates a numeric color scale spec that is resolved during widget compilation. Use in color/fill_color aesthetics (e.g. fill_color = color_numeric(~x)).

Usage

color_numeric(
  expr,
  palette = NULL,
  domain = NULL,
  steps = 256L,
  na_color = "#00000000",
  reverse = FALSE,
  clamp = TRUE
)

Arguments

Value

A color scale specification object.

Examples

if (requireNamespace("sf", quietly = TRUE)) {
  nc <- sf::st_read(system.file("shape/nc.shp", package = "sf"), quiet = TRUE)
  maplamina(nc) |>
    add_polygons(fill_color = color_numeric(~BIR74))
}

Quantile color scale specification

Description

Quantile color scale specification

Usage

color_quantile(
  expr,
  palette = NULL,
  n = 5,
  domain = NULL,
  na_color = "#00000000",
  reverse = FALSE,
  clamp = TRUE
)

Arguments

Value

A color scale specification object.

Define a range filter

Description

Creates a numeric range filter specification to be registered with add_filters().

Usage

filter_range(
  col,
  label = NULL,
  default = NULL,
  min = NULL,
  max = NULL,
  step = NULL,
  live = TRUE,
  id = NULL
)

Arguments

Value

A filter specification object.

Examples

f <- filter_range(~mpg, default = c(15, 30))
f

Define a select filter

Description

Creates a categorical filter specification to be registered with add_filters().

Usage

filter_select(
  col,
  label = NULL,
  multi = TRUE,
  dropdown = NULL,
  searchable = TRUE,
  default = NULL,
  max_levels = NULL,
  id = NULL
)

Arguments

Value

A filter specification object.

Examples

f <- filter_select(~Species, default = c("setosa", "versicolor"))
f

Create a Maplamina map widget

Description

Creates an interactive MapLibre + deck.gl map widget. You can add layers and UI components (views/filters/summaries/panel) with the ⁠add_*()⁠ functions.

Usage

maplamina(
  data = NULL,
  style = "https://basemaps.cartocdn.com/gl/positron-gl-style/style.json",
  projection = c("mercator", "globe"),
  dragRotate = FALSE,
  fit_bounds = TRUE,
  show_layer_controls = TRUE,
  width = NULL,
  height = NULL,
  elementId = NULL
)

Arguments

Value

An htmlwidget maplamina widget.

Examples

# Minimal widget
maplamina()

# With a Circle layer
d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d)

Create a panel section that mounts a control by bind id

Description

Panel sections refer to bind ids created by components such as add_views(), add_filters(), and add_summaries().

Usage

section(id)

Arguments

Value

A panel section object.

Examples

section("filters")

Create a list of panel sections

Description

Create a list of panel sections

Usage

sections(...)

Arguments

Value

A panel sections container.

Examples

sections(section("views"), section("filters"))

Summary: count rows

Description

Counts the number of filtered rows.

Usage

summary_count(
  col = NULL,
  label = NULL,
  digits = NULL,
  prefix = NULL,
  suffix = NULL,
  id = NULL
)

Arguments

Value

A summary specification object.

Summary: max value

Description

Summary: max value

Usage

summary_max(
  col,
  label = NULL,
  digits = NULL,
  prefix = NULL,
  suffix = NULL,
  id = NULL
)

Arguments

Value

A summary specification object.

Summary: mean value

Description

Summary: mean value

Usage

summary_mean(
  col,
  label = NULL,
  digits = NULL,
  prefix = NULL,
  suffix = NULL,
  id = NULL
)

Arguments

Value

A summary specification object.

Summary: min value

Description

Summary: min value

Usage

summary_min(
  col,
  label = NULL,
  digits = NULL,
  prefix = NULL,
  suffix = NULL,
  id = NULL
)

Arguments

Value

A summary specification object.

Summary: sum of values

Description

Summary: sum of values

Usage

summary_sum(
  col,
  label = NULL,
  digits = NULL,
  prefix = NULL,
  suffix = NULL,
  id = NULL
)

Arguments

Value

A summary specification object.

Create a tooltip/popup template

Description

Templates use placeholders like {col} or ⁠{col:.1f}⁠. Values are gathered during widget compilation for fast rendering in the browser.

Usage

tmpl(template, ..., html = FALSE)

Arguments

Value

A template specification object.

Examples

d <- data.frame(
  lon   = runif(1000, -60, 60),
  lat   = runif(1000, -60, 60),
  value = runif(1000, 1, 10)
)
maplamina() |>
  add_circles(d, tooltip = tmpl("Value: {value:.1f}"))

Deprecated transition helper

Description

transition() has been removed. Configure animated view switching via add_views() using duration and easing.

Usage

transition(...)

Arguments

Value

This function always errors with Defunct.

Define a view

Description

A view is a named set of overrides (e.g. radius/opacity) that can be switched via a shared views selector created by add_views().

Usage

view(name, ...)

Arguments

Value

A view specification object.

Examples

v <- view("magnitude", radius = ~mag * 3)
v