simplevis (version 5.0.0)

gg_stars: Stars ggplot map.

Description

Map of an array in ggplot that is not coloured and not facetted.

Usage

gg_stars(
  data,
  downsample = 0,
  pal = NULL,
  alpha = 0.5,
  borders = NULL,
  borders_on_top = TRUE,
  borders_pal = "#323232",
  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,
  mobile = FALSE
)

Arguments

data

A stars object with defined coordinate reference system. Note, it cannot be a stars_proxy object. Required input.

downsample

downsampling rate: e.g. 3 keeps rows and cols 1, 4, 7, 10 etc. A value of 0 does not downsample. It can be specified for each dimension. E.g. c(5,5,0) to downsample the first two dimensions but not the third.

pal

Character vector of hex codes.

alpha

The opacity of the array. Defaults to 0.5.

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 stars array. Defaults to TRUE.

borders_pal

Colour of the borders. Defaults to "#323232".

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

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.

mobile

Whether the plot is to be displayed on a mobile device. Defaults to FALSE. If within a shiny app with the mobileDetect function, then use mobile = input$isMobile.

Value

A ggplot object.

Examples

# NOT RUN {
library(simplevis)
library(stars)

gg_stars(example_stars, 
     borders = nz)
     
# }