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 <jwu96@students.ubc.cs.ca> Co-authored-by: Teun van den Brand <tahvdbrand@gmail.com> Co-authored-by: Teun van den Brand <49372158+teunbrand@users.noreply.github.com>
tidyverse · Feb 23, 2024 · e8a388e · e8a388e
1 parent 7c9a73a
commit e8a388e
Show file tree

Hide file tree

Showing 13 changed files with 37 additions and 29 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -79,7 +79,7 @@ Config/testthat/edition: 3
 Encoding: UTF-8
 LazyData: true
 Roxygen: list(markdown = TRUE)
-RoxygenNote: 7.3.0
+RoxygenNote: 7.3.1
 Collate: 
     'ggproto.R'
     'ggplot-global.R'

diff --git a/R/scale-.R b/R/scale-.R
@@ -257,6 +257,14 @@ discrete_scale <- function(aesthetics, scale_name = deprecated(), palette, name
 #'   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 explicitly.
+#' @param oob One of:
+#'   - Function that handles limits outside of the scale limits
+#'   (out of bounds). Also accepts rlang [lambda][rlang::as_function()]
+#'   function notation.
+#'   - The default ([scales::squish()]) squishes out of
+#'   bounds values into range.
+#'   - [scales::censor] for replacing out of bounds values with `NA`.
+#'   - [scales::squish_infinite()] for squishing infinite values into range.
 #' @param right Should the intervals be closed on the right (`TRUE`, default) or
 #'   should the intervals be closed on the left (`FALSE`)? 'Closed on the right'
 #'   means that values at break positions are part of the lower bin (open on the

diff --git a/man/aes_colour_fill_alpha.Rd b/man/aes_colour_fill_alpha.Rd
diff --git a/man/aes_group_order.Rd b/man/aes_group_order.Rd
diff --git a/man/aes_linetype_size_shape.Rd b/man/aes_linetype_size_shape.Rd
diff --git a/man/aes_position.Rd b/man/aes_position.Rd
diff --git a/man/binned_scale.Rd b/man/binned_scale.Rd
diff --git a/man/position_dodge.Rd b/man/position_dodge.Rd
diff --git a/man/position_identity.Rd b/man/position_identity.Rd
diff --git a/man/position_nudge.Rd b/man/position_nudge.Rd
diff --git a/man/position_stack.Rd b/man/position_stack.Rd
diff --git a/man/scale_binned.Rd b/man/scale_binned.Rd
diff --git a/man/scale_steps.Rd b/man/scale_steps.Rd