Skip to contents

Set the style

Source: R/set.R
set_blanket.Rd

Set the style by setting:

  1. the geom defaults, including the colour (and fill) of geoms (i.e. weave_geom_defaults)

  2. the colour (and fill) palettes (i.e. discrete, continuous and ordinal) (i.e. weave_col_palette)

  3. the theme, and how/what side-effects are to be applied (i.e. weave_theme)

  4. the function to apply to a unspecified/unlabelled x_label, y_label, col_label etc (i.e. weave_label_case).

set_font_defaults() and set_reference_defaults() can be used to customise "text", "label", "abline, "vline" and "hline" geom defaults.

ggplot2::update_geom_defaults() can be used to further fine-tune geom defaults.

Usage

set_blanket(
  ...,
  colour = "#357BA2FF",
  col_palette_d = jumble,
  col_palette_c = viridisLite::mako(n = 9, direction = -1),
  col_palette_o = scales::pal_viridis(option = "G", direction = -1),
  col_palette_na_d = "#CDC5BFFF",
  col_palette_na_c = "#988F88FF",
  col_palette_na_o = "#988F88FF",
  theme = light_mode_r(),
  theme_orientation = NULL,
  theme_axis_line_rm = TRUE,
  theme_axis_ticks_rm = TRUE,
  theme_panel_grid_rm = TRUE,
  label_case = snakecase::to_sentence_case
)

Arguments

...

Provided to require argument naming, support trailing commas etc.

colour

For most geoms, a default hex code for the colour of geoms (i.e. geoms other than "text", "label", "hline", "vline" and "abline"). Note "fill" inherits from this argument.

col_palette_d

For a discrete scale, a character vector of hex codes.

col_palette_c

For a continuous scale, a character vector of hex codes.

col_palette_o

For an ordinal scale, a scales::pal_*() function.

col_palette_na_d

For a discrete scale, a hex code.

col_palette_na_c

For a continuous scale, a hex code.

col_palette_na_o

For an ordinal scale, a hex code.

theme

A ggplot2 theme (e.g. light_mode_t() or dark_mode_r()).

theme_orientation

The orientation of plot, which affects the theme components that can be removed by the gg_* function. Either "x" or "y". Defaults to NULL, which lets the gg_* function guess it based on the data.

theme_axis_line_rm

TRUE or FALSE of whether the gg_* function should remove the relevant axis line per the theme_orientation of the plot.

theme_axis_ticks_rm

TRUE or FALSE of whether the gg_* function should remove the relevant axis ticks per the theme_orientation of the plot.

theme_panel_grid_rm

TRUE or FALSE of whether the gg_* function should remove the relevant panel grid per the theme_orientation of the plot.

label_case

A function to apply to a unspecified/unlabelled x_label, y_label, col_label etc. Defaults to snakecase::to_sentence_case.

Value

A globally set style.

Examples

library(ggplot2)
library(ggblanket)
library(palmerpenguins)

set_blanket(
  theme = dark_mode_r(),
  colour = "#E7298AFF",
  col_palette_d = c("#1B9E77FF", "#D95F02FF", "#7570b3FF", "#E7298AFF",
                    "#66A61EFF", "#E6AB02FF", "#A6761DFF", "#666666FF"),
)

penguins |>
  gg_point(
    x = flipper_length_mm,
    y = body_mass_g,
  )
#> Warning: Removed 2 rows containing missing values or values outside the scale range
#> (`geom_point()`).


penguins |>
  gg_histogram(
    x = flipper_length_mm,
    col = species,
  )
#> Scale for colour is already present.
#> Adding another scale for colour, which will replace the existing scale.
#> `stat_bin()` using `bins = 30`. Pick better value with `binwidth`.
#> Warning: Removed 2 rows containing non-finite outside the scale range (`stat_bin()`).