simplevis (version 2.4.0)

ggplot_sf: Map of simple features in ggplot.

Description

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

Usage

ggplot_sf(data, size = 0.5, alpha = 0.1, pal = NULL,
  boundary = NULL, boundary_behind = TRUE, boundary_pal = "#7f7f7f",
  boundary_size = 0.2, title = "[Title]", subtitle = NULL,
  caption = NULL, font_family = "Helvetica", font_size_title = NULL,
  font_size_body = NULL, title_wrap = 70, subtitle_wrap = 80,
  caption_wrap = 80, isMobile = FALSE)

Arguments

data

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

size

Size of features (or shape outlines if polygon). 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 a default palette.

boundary

A sf object as administrative boundaries (or coastlines). Defaults to no boundaries added.

boundary_behind

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

boundary_pal

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

boundary_size

Size of the boundary. Defaults to 0.2.

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.

title_wrap

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

subtitle_wrap

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

caption_wrap

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. If within an app with the mobileDetect function, then use isMobile = input$isMobile.

Value

A ggplot object.

Examples

# NOT RUN {
ggplot_sf(data = example_sf_point, boundary = nz)
# }