Skip to content

Commit e8a388e

Browse files
joshhwuujosh wteunbrand
authored
Fixing documentation in binned_scale suggesting it defaults to oob = censor (#5691)
* Fixed documentation for binned_scaled defaulting to oob = squish * Fixed documentation for binned_scaled defaulting to oob = squish * Changed roxygen2 documentation for binned scale * Dismiss older Hmisc changes --------- Co-authored-by: josh w <[email protected]> Co-authored-by: Teun van den Brand <[email protected]> Co-authored-by: Teun van den Brand <[email protected]>
1 parent 7c9a73a commit e8a388e

13 files changed

+37
-29
lines changed

DESCRIPTION

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ Config/testthat/edition: 3
7979
Encoding: UTF-8
8080
LazyData: true
8181
Roxygen: list(markdown = TRUE)
82-
RoxygenNote: 7.3.0
82+
RoxygenNote: 7.3.1
8383
Collate:
8484
'ggproto.R'
8585
'ggplot-global.R'

R/scale-.R

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -257,6 +257,14 @@ discrete_scale <- function(aesthetics, scale_name = deprecated(), palette, name
257257
#' the scale will ask the transformation object to create breaks, and this
258258
#' may result in a different number of breaks than requested. Ignored if
259259
#' breaks are given explicitly.
260+
#' @param oob One of:
261+
#' - Function that handles limits outside of the scale limits
262+
#' (out of bounds). Also accepts rlang [lambda][rlang::as_function()]
263+
#' function notation.
264+
#' - The default ([scales::squish()]) squishes out of
265+
#' bounds values into range.
266+
#' - [scales::censor] for replacing out of bounds values with `NA`.
267+
#' - [scales::squish_infinite()] for squishing infinite values into range.
260268
#' @param right Should the intervals be closed on the right (`TRUE`, default) or
261269
#' should the intervals be closed on the left (`FALSE`)? 'Closed on the right'
262270
#' means that values at break positions are part of the lower bin (open on the

man/aes_colour_fill_alpha.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/aes_group_order.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/aes_linetype_size_shape.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/aes_position.Rd

Lines changed: 2 additions & 2 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/binned_scale.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/position_dodge.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/position_identity.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/position_nudge.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/position_stack.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_binned.Rd

Lines changed: 3 additions & 3 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

man/scale_steps.Rd

Lines changed: 10 additions & 10 deletions
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

0 commit comments

Comments
 (0)