simplevis (version 1.1.4)

ggplot_sf_facet: Map of simple features in ggplot that is facetted.

Description

Map of simple features in ggplot that is facetted, but not coloured.

Usage

ggplot_sf_facet(data, facet_var, size = 0.5, alpha = 0.1, pal = NULL,
  facet_nrow = NULL, coastline = NULL, coastline_behind = TRUE,
  coastline_pal = "#7f7f7f", title = "[Title]", subtitle = NULL,
  caption = "", font_family = "Helvetica", font_size_title = NULL,
  font_size_body = NULL, wrap_title = 70, wrap_subtitle = 80,
  wrap_caption = 80, isMobile = FALSE)

Arguments

data

A sf object with defined coordinate reference system. Required input.

facet_var

Unquoted categorical variable to facet the data by. Required input.

size

Size of points. Defaults to 0.5.

alpha

The alpha of the fill. Defaults to 0.1. Only applicable to polygons.

pal

Character vector of hex codes. Defaults to NULL, which selects the Stats NZ palette.

facet_nrow

The number of rows of facetted plots. Not applicable to where isMobile is TRUE.

coastline

Add a sf object as a coastline (or administrative boundaries). Defaults to NULL. Use nz (or nz_region) to add a new zealand coastline. Or add a custom sf object.

coastline_behind

TRUE or FALSE as to whether the coastline is to be behind the sf object defined in the data argument. Defaults to FALSE.

coastline_pal

Colour of the coastline. Defaults to "#7F7F7F".

title

Title string. Defaults to "[Title]".

subtitle

Subtitle string. Defaults to "[Subtitle]".

caption

Caption title string. Defaults to NULL.

font_family

Font family to use. Defaults to "Helvetica".

font_size_title

Font size for the title text. Defaults to 11.

font_size_body

Font size for all text other than the title. Defaults to 10.

wrap_title

Number of characters to wrap the title to. Defaults to 70. Not applicable where isMobile equals TRUE.

wrap_subtitle

Number of characters to wrap the subtitle to. Defaults to 80. Not applicable where isMobile equals TRUE.

wrap_caption

Number of characters to wrap the caption to. Defaults to 80. Not applicable where isMobile equals TRUE.

isMobile

Whether the plot is to be displayed on a mobile device. Defaults to FALSE. In a shiny app, use input$isMobile if your app is able to retreive this input. A method to do this is described at https://g3rv4.com/2017/08/shiny-detect-mobile-browsers

Value

A ggplot object.

Examples

# NOT RUN {
map_data <- example_sf_nz_river_wq %>%
 dplyr::filter(period == "1998-2017", indicator == "Nitrate-nitrogen")

ggplot_sf_facet(data = map_data, facet_var = trend_category, coastline = nz,
  title = "Monitored river nitrate-nitrogen trends, 2008-17")
# }