simplevis (version 4.0.0)

leaflet_sf_col: Simple feature leaflet map that is coloured.

Description

Map of simple features in leaflet that is coloured.

Usage

leaflet_sf_col(
  data,
  col_var,
  text_var = NULL,
  popup_vars_vctr = NULL,
  pal = NULL,
  pal_rev = FALSE,
  size_point = 2,
  size_line = 2,
  alpha = 0.9,
  basemap = "light",
  title = NULL,
  col_cuts = NULL,
  col_labels_dp = NULL,
  col_method = NULL,
  col_na = TRUE,
  map_id = "map"
)

Arguments

data

An sf object of geometry type point/multipoint, linestring/multilinestring or polygon/multipolygon geometry type. Required input.

col_var

Unquoted variable to colour the features by. Required input.

text_var

Unquoted variable to label the features by. If NULL, defaults to using the colour variable.

popup_vars_vctr

Vector of quoted variable names to include in the popup. If NULL, defaults to making a leafpop::popupTable of all columns.

pal

Character vector of hex codes.

pal_rev

Reverses the palette. Defaults to FALSE.

size_point

Size of points (i.e. radius). Defaults to 2.

size_line

Size of lines around features (i.e. weight). Defaults to 2.

alpha

The opacity of the fill within features (i.e. fillOpacity). Defaults to 0.1.

basemap

The underlying basemap. Either "light", "dark", "satellite", "street", or "ocean". Defaults to "light". Only applicable where shiny equals FALSE.

title

A title string that will be wrapped into the legend.

col_cuts

A vector of cuts to colour a numeric variable. If "bin" is selected, the first number in the vector should be either -Inf or 0, and the final number Inf. If "quantile" is selected, the first number in the vector should be 0 and the final number should be 1. Defaults to quartiles.

col_labels_dp

For numeric colour variables, the number of decimal places. Defaults to 1 for "quantile" col_method, and the lowest dp within the col_cuts vector for "bin".

col_method

The method of colouring features, either "bin", "quantile" or "category." if categorical colour variable, NULL results in "category". If numeric variable, defaults to "quantile". Note all numeric variables are cut to be inclusive of the min in the range, and exclusive of the max in the range (except for the final bucket which includes the highest value).

col_na

TRUE or FALSE of whether to include col_var NA values. Defaults to TRUE.

map_id

The shiny map id for a leaflet map within a shiny app. For standard single-map apps, id "map" should be used. For dual-map apps, "map1" and "map2" should be used. Defaults to "map".

Value

A leaflet object.

Examples

# NOT RUN {
leaflet_sf_col(example_sf_polygon, density,
     col_method = "quantile", col_cuts = c(0, 0.25, 0.5, 0.75, 0.95, 1))

leaflet_sf_col(example_sf_polygon, density,
     col_method = "bin", col_cuts = c(0, 10, 50, 100, 150, 200, Inf))

leaflet_sf_col(example_sf_point, trend_category, pal = c("#4575B4", "#D3D3D3", "#D73027"))
# }