Learn R Programming

simplevis (version 4.5.0)

gg_sf_col_facet: Simple feature ggplot map that is coloured and facetted.

Description

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

Usage

gg_sf_col_facet(
  data,
  col_var,
  facet_var,
  text_var = NULL,
  pal = NULL,
  pal_borders = "#7F7F7FFF",
  pal_na = "#7F7F7FFF",
  pal_rev = FALSE,
  size_point = 1,
  size_line = 0.5,
  alpha = 0.9,
  borders = NULL,
  borders_behind = TRUE,
  borders_size = 0.2,
  title = NULL,
  title_wrap = 100,
  subtitle = NULL,
  subtitle_wrap = 100,
  col_cuts = NULL,
  col_labels = NULL,
  col_method = NULL,
  col_na = TRUE,
  col_pretty_n = 4,
  col_right_closed = TRUE,
  col_title = NULL,
  col_title_wrap = 25,
  facet_labels = stringr::str_to_sentence,
  facet_na = TRUE,
  facet_ncol = NULL,
  facet_nrow = NULL,
  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.

col_var

Unquoted variable for points to be coloured by. 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.

pal

Character vector of hex codes. Defaults to NULL, which selects the colorbrewer Set1 or viridis.

pal_borders

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

pal_na

The hex code or name of the NA colour to be used.

pal_rev

Reverses the palette. Defaults to FALSE.

size_point

Size of points. Defaults to 0.5.

size_line

Size of lines. Defaults to 0.5.

alpha

The opacity of polygons. Defaults to 0.9.

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

col_cuts

A vector of cuts to colour a numeric variable. If "bin" is selected, the first number in the vector should be either -Inf or 0, and the final number Inf. If "quantile" is selected, the first number in the vector should be 0 and the final number should be 1. Defaults to quartiles.

col_labels

A function or named vector to modify colour scale labels. Defaults to stringr::str_to_sentence for categorical colour variables and an internal function for numeric colour variables. Use ggplot2::waiver() to keep colour labels untransformed.

col_method

The method of colouring features, either "bin", "quantile" or "category." If numeric, defaults to "bin".

col_na

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

col_pretty_n

For a numeric colour variable of "bin" col_method, the desired number of intervals on the colour scale, as calculated by the pretty algorithm. Defaults to 4.

col_right_closed

For a numeric colour variable, TRUE or FALSE of whether bins or quantiles are to be cut right-closed. Defaults to TRUE.

col_title

Colour title string for the legend. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.

col_title_wrap

Number of characters to wrap the colour title to. Defaults to 25.

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

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.

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

Run this code
# NOT RUN {
gg_sf_col_facet(example_sf_point, 
                col_var = trend_category, 
                facet_var = trend_category, 
                borders = nz)
 
# }

Run the code above in your browser using DataLab