Skip to content

Improve scale_(x|y)_continuous docs #3411

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Jul 16, 2019
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 9 additions & 5 deletions R/scale-.r
Original file line number Diff line number Diff line change
Expand Up @@ -38,17 +38,21 @@
#' Use `NA` to refer to the existing minimum or maximum
#' - A 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()]).
#' 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()]).
#' @param 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 ways use [scales::rescale()].
#' @param oob Function that handles limits outside of the scale limits
#' (out of bounds). The default ([scales::censor()]) replaces out of
#' @param 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 infitite values into range.
#' @param na.value Missing values will be replaced with this value.
#' @param trans For continuous scales, the name of a transformation object
#' or the object itself. Built-in transformations include "asn", "atanh",
Expand Down
18 changes: 12 additions & 6 deletions man/continuous_scale.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions man/scale_continuous.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions man/scale_date.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

18 changes: 12 additions & 6 deletions man/scale_gradient.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

24 changes: 15 additions & 9 deletions man/scale_size.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.