# binned_scale

##### Binning scale constructor

Binning scale constructor

- Keywords
- internal

##### Usage

```
binned_scale(
aesthetics,
scale_name,
palette,
name = waiver(),
breaks = waiver(),
labels = waiver(),
limits = NULL,
rescaler = rescale,
oob = squish,
expand = waiver(),
na.value = NA_real_,
n.breaks = NULL,
nice.breaks = TRUE,
right = TRUE,
trans = "identity",
show.limits = FALSE,
guide = "bins",
position = "left",
super = ScaleBinned
)
```

##### Arguments

- aesthetics
The names of the aesthetics that this scale works with.

- scale_name
The name of the scale that should be used for error messages associated with this scale.

- palette
A palette function that when called with a numeric vector with values between 0 and 1 returns the corresponding output values (e.g.,

`scales::area_pal()`

).- name
The name of the scale. Used as the 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 objectA numeric vector of positions

A function that takes the limits as input and returns breaks as output (e.g., a function returned by

`scales::extended_breaks()`

)

- labels
One of:

`NULL`

for no labels`waiver()`

for the default labels computed by the transformation objectA character vector giving labels (must be same length as

`breaks`

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

- limits
One of:

`NULL`

to use the default scale rangeA numeric vector of length two providing limits of the scale. Use

`NA`

to refer to the existing minimum or maximumA function that accepts the existing (automatic) limits and returns new limits Note that setting limits on positional scales will

**remove**data outside of the limits. If the purpose is to zoom, use the limit argument in the coordinate system (see`coord_cartesian()`

).

- rescaler
A function used to scale the input values to the range [0, 1]. This is always

`scales::rescale()`

, except for diverging and n colour gradients (i.e.,`scale_colour_gradient2()`

,`scale_colour_gradientn()`

). The`rescaler`

is ignored by position scales, which always use`scales::rescale()`

.- oob
One of:

Function that handles limits outside of the scale limits (out of bounds).

The default (

`scales::censor()`

) replaces out of bounds values with`NA`

.`scales::squish()`

for squishing out of bounds values into range.`scales::squish_infinite()`

for squishing infinite values into range.

- expand
For position scales, a 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

`expansion()`

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.

- n.breaks
The number of break points to create if breaks are not given directly.

- nice.breaks
Logical. Should breaks be attempted placed at nice values instead of exactly evenly spaced between the limits. If

`TRUE`

(default) the scale will ask the transformation object to create breaks, and this may result in a different number of breaks than requested. Ignored if breaks are given explicetly.- right
Should values on the border between bins be part of the right (upper) bin?

- trans
For continuous scales, the name of a transformation object or the object itself. Built-in transformations include "asn", "atanh", "boxcox", "date", "exp", "hms", "identity", "log", "log10", "log1p", "log2", "logit", "modulus", "probability", "probit", "pseudo_log", "reciprocal", "reverse", "sqrt" and "time".

A transformation object bundles together a transform, its inverse, and methods for generating breaks and labels. Transformation objects are defined in the scales package, and are called

`<name>_trans`

(e.g.,`scales::boxcox_trans()`

). You can create your own transformation with`scales::trans_new()`

.- show.limits
should the limits of the scale appear as ticks

- guide
A function used to create a guide or its name. See

`guides()`

for more information.- position
For position scales, The position of the axis.

`left`

or`right`

for y axes,`top`

or`bottom`

for x axes.- super
The super class to use for the constructed scale

*Documentation reproduced from package ggplot2, version 3.3.2, License: GPL-2 | file LICENSE*