R: Edge colour scales

scale_edge_colour {ggraph} | R Documentation

## Edge colour scales

### Description

This set of scales defines new colour scales for edge geoms equivalent to the ones already defined by ggplot2. The parameters are equivalent to the ones from ggplot2 so there is nothing new under the sun. The different geoms will know whether to use edge scales or the standard scales so it is not necessary to write `edge_colour` in the call to the geom - just use `colour`.

### Usage

    scale_edge_colour_hue(..., h = c(0, 360) + 15, c = 100, l = 65,
      h.start = 0, direction = 1, na.value = "grey50")

    scale_edge_colour_brewer(..., type = "seq", palette = 1, direction = 1)

    scale_edge_colour_distiller(..., type = "seq", palette = 1,
      direction = -1, values = NULL, space = "Lab", na.value = "grey50",
      guide = "edge_colourbar")

    scale_edge_colour_gradient(..., low = "#132B43", high = "#56B1F7",
      space = "Lab", na.value = "grey50", guide = "edge_colourbar")

    scale_edge_colour_gradient2(..., low = muted("red"), mid = "white",
      high = muted("blue"), midpoint = 0, space = "Lab",
      na.value = "grey50", guide = "edge_colourbar")

    scale_edge_colour_gradientn(..., colours, values = NULL, space = "Lab",
      na.value = "grey50", guide = "edge_colourbar", colors)

    scale_edge_colour_grey(..., start = 0.2, end = 0.8, na.value = "red")

    scale_edge_colour_identity(..., guide = "none")

    scale_edge_colour_manual(..., values)

    scale_edge_colour_viridis(..., alpha = 1, begin = 0, end = 1,
      discrete = FALSE, option = "D", direction = 1)

    scale_edge_colour_continuous(..., low = "#132B43", high = "#56B1F7",
      space = "Lab", na.value = "grey50", guide = "edge_colourbar")

    scale_edge_colour_discrete(..., h = c(0, 360) + 15, c = 100, l = 65,
      h.start = 0, direction = 1, na.value = "grey50")

    scale_edge_color_hue(..., h = c(0, 360) + 15, c = 100, l = 65,
      h.start = 0, direction = 1, na.value = "grey50")

    scale_edge_color_brewer(..., type = "seq", palette = 1, direction = 1)

    scale_edge_color_distiller(..., type = "seq", palette = 1, direction = -1,
      values = NULL, space = "Lab", na.value = "grey50",
      guide = "edge_colourbar")

    scale_edge_color_gradient(..., low = "#132B43", high = "#56B1F7",
      space = "Lab", na.value = "grey50", guide = "edge_colourbar")

    scale_edge_color_gradient2(..., low = muted("red"), mid = "white",
      high = muted("blue"), midpoint = 0, space = "Lab",
      na.value = "grey50", guide = "edge_colourbar")

    scale_edge_color_gradientn(..., colours, values = NULL, space = "Lab",
      na.value = "grey50", guide = "edge_colourbar", colors)

    scale_edge_color_grey(..., start = 0.2, end = 0.8, na.value = "red")

    scale_edge_color_identity(..., guide = "none")

    scale_edge_color_manual(..., values)

    scale_edge_color_continuous(..., low = "#132B43", high = "#56B1F7",
      space = "Lab", na.value = "grey50", guide = "edge_colourbar")

    scale_edge_color_discrete(..., h = c(0, 360) + 15, c = 100, l = 65,
      h.start = 0, direction = 1, na.value = "grey50")

    scale_edge_color_viridis(..., alpha = 1, begin = 0, end = 1,
      discrete = FALSE, option = "D", direction = 1)

### Arguments

`...` | Other arguments passed on to `discrete_scale` to control name, limits, breaks, labels and so forth.
`h` | range of hues to use, in [0, 360]
`c` | chroma (intensity of colour), maximum value varies depending on combination of hue and luminance.
`l` | luminance (lightness), in [0, 100]
`h.start` | hue to start at
`direction` | direction to travel around the colour wheel, 1 = clockwise, -1 = counter-clockwise
`na.value` | Colour to use for missing values
`type` | One of seq (sequential), div (diverging) or qual (qualitative)
`palette` | If a string, will use that named palette. If a number, will index into the list of palettes of appropriate `type`
`values` | if colours should not be evenly positioned along the gradient this vector gives the position (between 0 and 1) for each colour in the `colours` vector. See `rescale` for a convience function to map an arbitrary range to between 0 and 1.
`space` | colour space in which to calculate gradient. Must be "Lab" - other values are deprecated.
`guide` | Type of legend. Use `"colourbar"` for continuous colour bar, or `"legend"` for discrete colour legend.
`low, high` | Colours for low and high ends of the gradient.
`mid` | colour for mid point
`midpoint` | The midpoint (in data value) of the diverging scale. Defaults to 0.
`colours, colors` | Vector of colours to use for n-colour gradient.
`start` | gray value at low end of palette
`end` | gray value at high end of palette
`alpha` | pass through parameter to `viridis`
`begin` | The (corrected) hue in [0,1] at which the viridis colormap begins.
`discrete` | generate a discrete palette? (default: `FALSE` - generate continuous palette)
`option` | A character string indicating the colormap option to use. Four options are available: "magma" (or "A"), "inferno" (or "B"), "plasma" (or "C"), and "viridis" (or "D", the default option).

### Value

A ggproto object inheriting from `Scale`

### See Also

Other scale_edge_*: `scale_edge_alpha`, `scale_edge_fill`, `scale_edge_linetype`, `scale_edge_shape`, `scale_edge_size`, `scale_edge_width`, `scale_label_size`

[Package ggraph version 1.0.0 Index]