Skip to contents

Theme wrapper for guides

Source: R/themes.R
theme_guide.Rd

This function has shorthand names for theme elements relating to guides. It is intended to be used as the guide_*(theme) argument. Because of this intent, and due to legends and axes having mutually exclusive theme elements, this function sets the elements for both simultaneously.

Usage

theme_guide(
  text = NULL,
  line = NULL,
  title = NULL,
  subtitle = NULL,
  text.position = NULL,
  title.position = NULL,
  subtitle.position = NULL,
  ticks = NULL,
  minor.ticks = NULL,
  mini.ticks = NULL,
  ticks.length = NULL,
  minor.ticks.length = NULL,
  mini.ticks.length = NULL,
  spacing = NULL,
  key = NULL,
  key.size = NULL,
  key.width = NULL,
  key.height = NULL,
  key.spacing = NULL,
  key.spacing.x = NULL,
  key.spacing.y = NULL,
  frame = NULL,
  byrow = NULL,
  background = NULL,
  margin = NULL,
  bracket = NULL,
  bracket.size = NULL,
  box = NULL,
  fence = NULL,
  fence.post = NULL,
  fence.rail = NULL
)

Arguments

text

An <element_text> setting both legend.text and axis.text elements.

line

An <element_line> setting both legend.axis.line and axis.line elements.

title

An <element_text> setting both legend.title and axis.title elements.

subtitle

An <element_text> setting both gguidance.legend.subtitle and gguidance.axis.subtitle elements.

text.position, title.position, subtitle.position

One of "top", "right", "bottom" or "right" setting the following elements:

  • text.position: sets only legend.text.position.

  • title.position: sets only legend.title.position.

  • subtitle.position sets both gguidance.legend.subtitle.position and gguidance.axis.subtitle.position

ticks

An <element_line> setting both axis.ticks and legend.ticks elements.

minor.ticks

An <element_line> setting gguidance.legend.minor.ticks and all 6 of the axis.ticks.minor.{r/theta/x.top/x.bottom/y.left/y.right} elements.

mini.ticks

An <element_line> setting both gguidance.legend.mini.ticks and gguidance.axis.mini.ticks elements.

ticks.length, minor.ticks.length, mini.ticks.length

A [<unit[1]>][grid::unit()] setting the following elements:

  • ticks.length: sets both legend.ticks.length and axis.ticks.length.

  • minor.ticks.length sets both axis.minor.ticks.length and gguidance.legend.minor.ticks.length.

  • mini.ticks.length sets both gguidance.axis.mini.ticks.length and gguidance.legend.mini.ticks.length.

spacing

A [<unit[1]>][grid::unit()] setting the gguidance.guide.spacing theme element.

key

An <element_rect> setting the legend.key element.

key.size, key.width, key.height

A <unit> setting the legend.key.size, legend.key.width and legend.key.height elements respectively.

key.spacing, key.spacing.x, key.spacing.y

A [<unit[1]>][grid::unit()] setting the legend.key.spacing, legend.key.spacing.x and legend.key.spacing.y elements respectively.

frame

An <element_rect> setting the legend.frame element.

byrow

A <logical[1]> setting the legend.byrow element.

background

An <element_rect> setting the legend.background element.

margin

A <margin> setting the legend.margin element.

bracket

An <element_line> setting the gguidance.bracket element.

bracket.size

A [<unit[1]>][grid::unit()] setting the gguidance.bracket.size element.

box

An <element_rect> setting the gguidance.box element.

fence, fence.post, fence.rail

An <element_line> setting the gguidance.fence, gguidance.fence.post and gguidance.fence.rail respectively.

Value

A <theme> object that can be provided to a guide.

Examples

red_ticks <- theme_guide(ticks = element_line(colour = "red", linewidth = 0.5))

# Both axis and colourbar gain red ticks
ggplot(mpg, aes(displ, hwy, colour = cty)) +
  geom_point() +
  guides(
    colour = guide_colourbar(theme = red_ticks),
    x = guide_axis(theme = red_ticks)
  )