gg_sf: Simple feature ggplot map.

Description Usage Arguments Value Examples

View source: R/gg_sf.R

Description

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

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
gg_sf(
  data,
  text_var = NULL,
  borders = NULL,
  borders_on_top = NULL,
  pal = pal_viridis_reorder(1),
  pal_borders = "#7F7F7F",
  alpha_fill = NULL,
  alpha_line = 1,
  alpha_point = 1,
  alpha_borders = 0.5,
  size_line = 0.5,
  size_point = 1,
  size_borders = 0.2,
  title = NULL,
  title_wrap = 80,
  subtitle = NULL,
  subtitle_wrap = 80,
  caption = NULL,
  caption_wrap = 80,
  theme = NULL,
  mobile = FALSE
)

Arguments

data

A sf object with defined coordinate reference system in a structure to be plotted untransformed. Required input.

text_var

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

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..

pal

Character vector of hex codes.

pal_borders

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

alpha_fill

The opacity of the fill.

alpha_line

The alpha of lines and outlines.

alpha_point

The alpha of points.

alpha_borders

Opacity of the borders. Defaults to 0.5.

size_line

Size of lines. Defaults to 0.5.

size_point

Size of points. Defaults to 1.

size_borders

Size of the borders. Defaults to 0.2.

title

Title string.

title_wrap

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

subtitle

Subtitle string.

subtitle_wrap

Number of characters to wrap the subtitle to. Defaults to 100. Not applicable where mobile equals TRUE.

caption

Caption title string.

caption_wrap

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

theme

A ggplot2 theme.

mobile

Whether the plot is to be displayed on a mobile device. Defaults to FALSE.

Value

A ggplot object.

Examples

1
2
3

simplevis documentation built on Jan. 15, 2022, 1:08 a.m.