bivariate_scale: Constructor for bivariate scale object

Description Usage Arguments Format

View source: R/scale_bivariate.R

Description

Constructor for bivariate scale object

Usage

1
2
3
4
bivariate_scale(aesthetics, palette, name = waiver(), breaks = waiver(),
  labels = waiver(), limits = NULL, rescaler = rescale, oob = censor,
  expand = waiver(), na.value = NA_real_, trans = "identity",
  guide = "none", super = ScaleBivariate, scale_name = "bivariate_scale")

Arguments

aesthetics

The names of the aesthetics that this scale works with

palette

A palette function that when called with a single integer argument (the number of levels in the scale) returns the values that they should take

name

The name of the scale. Used as axis or legend title. If waiver(), the default, the name of the scale is taken from the first mapping used for that aesthetic. If NULL, the legend title will be omitted.

breaks

One of:

  • NULL for no breaks

  • waiver() for the default breaks computed by the transformation object

  • A numeric vector of positions

  • A function that takes the limits as input and returns breaks as output

labels

One of:

  • NULL for no labels

  • waiver() for the default labels computed by the transformation object

  • A character vector giving labels (must be same length as breaks)

  • A function that takes the breaks as input and returns labels as output

limits

Data frame with two columns of length two each defining the limits for the two data dimensions.

rescaler

Either one rescaling function applied to both data dimensions or list of two rescaling functions, one for each data dimension.

oob

Function that handles limits outside of the scale limits (out of bounds). The default replaces out of bounds values with NA.

expand

Vector of range expansion constants used to add some padding around the data, to ensure that they are placed some distance away from the axes. Use the convenience function expand_scale() to generate the values for the expand argument. The defaults are to expand the scale by 5% on each side for continuous variables, and by 0.6 units on each side for discrete variables.

na.value

Missing values will be replaced with this value.

trans

Either one transformation applied to both data dimensions or list of two transformations, one for each data dimension. Transformations can be given as either the name of a transformation object or the object itself. See ggplot2::continuous_scale() for details.

guide

A function used to create a guide or its name. See guides() for more info.

super

The super class to use for the constructed scale

scale_name

The name of the scale

Format

An object of class ScaleBivariate (inherits from Scale, ggproto, gg) of length 16.


clauswilke/multiscales documentation built on Jan. 8, 2022, 10:49 p.m.