Map of an array in ggplot that is coloured, but not facetted.
gg_stars_col(
data,
col_var,
downsample = 0,
pal = NULL,
pal_na = "#7F7F7F",
pal_rev = FALSE,
alpha = 1,
borders = NULL,
borders_on_top = TRUE,
borders_pal = "#7F7F7F",
borders_size = 0.2,
title = NULL,
title_wrap = 80,
subtitle = NULL,
subtitle_wrap = 80,
col_cuts = NULL,
col_label_digits = NULL,
col_labels = NULL,
col_na_rm = FALSE,
col_pretty_n = 5,
col_method = NULL,
col_right_closed = TRUE,
col_title = NULL,
col_title_wrap = 25,
caption = NULL,
caption_wrap = 80,
font_family = "",
font_size_title = NULL,
font_size_body = NULL,
mobile = FALSE
)A stars object with defined coordinate reference system. Note, it cannot be a stars_proxy object. Required input.
Unquoted variable for points to be coloured by. Required input.
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.
Character vector of hex codes. Defaults to NULL, which selects the colorbrewer Set1 or viridis.
The hex code or name of the NA colour to be used.
Reverses the palette. Defaults to FALSE.
The opacity of features. Defaults to 1 for points/lines, or 0.95 for polygons.
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.
TRUE or FALSE as to whether the borders are on top of the stars array. Defaults to TRUE.
Colour of the borders. Defaults to "#7F7F7F".
Size of the borders. Defaults to 0.2.
Title string.
Number of characters to wrap the title to. Defaults to 75.
Subtitle string.
Number of characters to wrap the subtitle to. Defaults to 100. Not applicable where mobile equals TRUE.
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.
If numeric colour method, the number of digits to round the labels to. Only applicable where col_labels equals NULL.
A function or named vector to modify colour scale labels. Defaults to stringr::str_to_sentence for categorical colour variables and scales::comma for numeric colour variables. Use ggplot2::waiver() to keep colour labels untransformed.
TRUE or FALSE of whether to visualise col_var NA values. Defaults to FALSE.
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 5.
The method of colouring features, either "bin", "quantile" or "category." If numeric, defaults to "bin".
For a numeric colour variable, TRUE or FALSE of whether bins or quantiles are to be cut right-closed. Defaults to TRUE.
Colour title string for the legend. Defaults to NULL, which converts to sentence case with spaces. Use "" if you would like no title.
Number of characters to wrap the colour title to. Defaults to 25. Not applicable where mobile equals TRUE.
Caption title string.
Number of characters to wrap the caption to. Defaults to 80.
Font family to use. Defaults to "".
Font size for the title text. Defaults to 11.
Font size for all text other than the title. Defaults to 10.
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.
A ggplot object.
# NOT RUN {
library(simplevis)
library(stars)
gg_stars_col(example_stars,
col_var = nitrate,
col_method = "quantile",
col_cuts = c(0, 0.05, 0.25, 0.5, 0.75, 0.95, 1),
col_na_rm = TRUE,
borders = nz)
# }
Run the code above in your browser using DataLab