simplevis (version 4.4.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 = 0.9, pal = NULL, facet_labels = NULL,
  facet_na = TRUE, facet_ncol = NULL, facet_nrow = NULL,
  borders = NULL, borders_behind = TRUE, borders_pal = "#7f7f7f",
  borders_size = 0.2, title = NULL, title_wrap = 100,
  subtitle = NULL, subtitle_wrap = 100, 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 alpha of the fill. Defaults to 0.9.

pal

Character vector of hex codes.

facet_labels

As per the ggplot2 labeller argument within the ggplot facet_wrap function. If NULL, defaults to ggplot2::as_labeller(stringr::str_to_sentence). Use facet_labels = ggplot2::label_value to turn off default sentence case transformation.

facet_na

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

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_behind

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

borders_pal

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

borders_size

Size of the borders. Defaults to 0.2.

title

Title string. Defaults to NULL.

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)

# }