R: Colourbar legend for edges

guide_edge_colourbar {ggraph} | R Documentation

## Colourbar legend for edges

### Description

This function is equivalent to `ggplot2::guide_colourbar()` but works for edge aesthetics.

### Usage

    guide_edge_colourbar(
      title = waiver(),
      title.position = NULL,
      title.theme = NULL,
      title.hjust = NULL,
      title.vjust = NULL,
      label = TRUE,
      label.position = NULL,
      label.theme = NULL,
      label.hjust = NULL,
      label.vjust = NULL,
      barwidth = NULL,
      barheight = NULL,
      nbin = 20,
      raster = TRUE,
      ticks = TRUE,
      draw.ulim = TRUE,
      draw.llim = TRUE,
      direction = NULL,
      default.unit = "line",
      reverse = FALSE,
      order = 0,
      ...
    )

    guide_edge_colorbar(
      title = waiver(),
      title.position = NULL,
      title.theme = NULL,
      title.hjust = NULL,
      title.vjust = NULL,
      label = TRUE,
      label.position = NULL,
      label.theme = NULL,
      label.hjust = NULL,
      label.vjust = NULL,
      barwidth = NULL,
      barheight = NULL,
      nbin = 20,
      raster = TRUE,
      ticks = TRUE,
      draw.ulim = TRUE,
      draw.llim = TRUE,
      direction = NULL,
      default.unit = "line",
      reverse = FALSE,
      order = 0,
      ...
    )

### Arguments

`title` | A character string or expression indicating a title of guide. If `NULL`, the title is not shown. By default (`waiver()`), the name of the scale object or the name specified in `labs()` is used for the title.
`title.position` | A character string indicating the position of a title. One of "top" (default for a vertical guide), "bottom", "left" (default for a horizontal guide), or "right."
`title.theme` | A theme object for rendering the title text. Usually the object of `element_text()` is expected. By default, the theme is specified by `legend.title` in `theme()` or theme.
`title.hjust` | A number specifying horizontal justification of the title text.
`title.vjust` | A number specifying vertical justification of the title text.
`label` | logical. If `TRUE` then the labels are drawn. If `FALSE` then the labels are invisible.
`label.position` | A character string indicating the position of a label. One of "top", "bottom" (default for horizontal guide), "left", or "right" (default for vertical guide).
`label.theme` | A theme object for rendering the label text. Usually the object of `element_text()` is expected. By default, the theme is specified by `legend.text` in `theme()`.
`label.hjust` | A numeric specifying horizontal justification of the label text.
`label.vjust` | A numeric specifying vertical justification of the label text.
`barwidth` | A numeric or a `grid::unit()` object specifying the width of the colourbar. Default value is `legend.key.width` or `legend.key.size` in `theme()` or theme.
`barheight` | A numeric or a `grid::unit()` object specifying the height of the colourbar. Default value is `legend.key.height` or `legend.key.size` in `theme()` or theme.
`nbin` | A numeric specifying the number of bins for drawing the colourbar. A smoother colourbar results from a larger value.
`raster` | A logical. If `TRUE` then the colourbar is rendered as a raster object. If `FALSE` then the colourbar is rendered as a set of rectangles. Note that not all graphics devices are capable of rendering raster image.
`ticks` | A logical specifying if tick marks on the colourbar should be visible.
`draw.ulim` | A logical specifying if the upper limit tick marks should be visible.
`draw.llim` | A logical specifying if the lower limit tick marks should be visible.
`direction` | A character string indicating the direction of the guide. One of "horizontal" or "vertical."
`default.unit` | A character string indicating `grid::unit()` for `barwidth` and `barheight`.
`reverse` | logical. If `TRUE` the colourbar is reversed. By default, the highest value is on the top and the lowest value is on the bottom
`order` | positive integer less than 99 that specifies the order of this guide among multiple guides. This controls the order in which multiple guides are displayed, not the contents of the guide itself. If 0 (default), the order is determined by a secret algorithm.
`...` | ignored.

### Value

A guide object

[Package ggraph version 2.0.2 Index]