simplevis (version 5.0.0)

gg_sf_facet: Simple feature ggplot map that is facetted.

Description

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

Usage

gg_sf_facet(
  data,
  facet_var,
  text_var = NULL,
  size_point = 1,
  size_line = 0.5,
  alpha = NULL,
  pal = NULL,
  facet_labels = stringr::str_to_sentence,
  facet_na_rm = FALSE,
  facet_ncol = NULL,
  facet_nrow = NULL,
  borders = NULL,
  borders_on_top = NULL,
  borders_pal = "#7F7F7F",
  borders_size = 0.2,
  title = NULL,
  title_wrap = 80,
  subtitle = NULL,
  subtitle_wrap = 80,
  caption = NULL,
  caption_wrap = 80,
  font_family = "",
  font_size_title = NULL,
  font_size_body = NULL
)

Arguments

data

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

facet_var

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

text_var

Unquoted variable to be used as a customised tooltip in combination with plotly::ggplotly(plot, tooltip = "text"). Defaults to NULL.

size_point

Size of points. Defaults to 0.5.

size_line

Size of lines. Defaults to 0.5.

alpha

The opacity of features. Defaults to 1 for points/lines, or 0.5 for polygons.

pal

Character vector of hex codes.

facet_labels

A function or named vector to modify facet scale labels. Defaults to converting labels to sentence case. Use ggplot2::waiver() to keep facet labels untransformed.

facet_na_rm

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

facet_ncol

The number of columns of facetted plots.

facet_nrow

The number of rows of facetted plots.

borders

A sf object as administrative boundaries (or coastlines). Defaults to no boundaries added. The rnaturalearth package is a useful source of country and state boundaries.

borders_on_top

TRUE or FALSE as to whether the borders are on top of the sf object supplied to the data argument. Defaults to TRUE for points and lines, but FALSE for polygons..

borders_pal

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

borders_size

Size of the borders. Defaults to 0.2.

title

Title string.

title_wrap

Number of characters to wrap the title to. Defaults to 100.

subtitle

Subtitle string.

subtitle_wrap

Number of characters to wrap the subtitle to. Defaults to 100.

caption

Caption title string.

caption_wrap

Number of characters to wrap the caption to. Defaults to 80.

font_family

Font family to use. Defaults to "".

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.

Value

A ggplot object.

Examples

# NOT RUN {
gg_sf_facet(example_sf_point, 
            facet_var = trend_category, 
            borders = nz)

# }