document news

Author: teunbrand

R/scale-.R

@@ -92,6 +92,8 @@
 #'   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.
+#' @param fallback.palette Function to use when `palette = NULL` and the
+#'   palette is not represented in the theme.
 #' @param position For position scales, The position of the axis.
 #' `left` or `right` for y axes, `top` or `bottom` for x axes.
 #' @param call The `call` used to construct the scale for reporting messages.

R/scale-discrete-.R

@@ -10,7 +10,7 @@
 #' level, and increasing by one for each level (i.e. the labels are placed
 #' at integer positions).  This is what allows jittering to work.
 #'
-#' @inheritDotParams discrete_scale -scale_name
+#' @inheritDotParams discrete_scale -scale_name -fallback.palette
 #' @inheritParams discrete_scale
 #' @param palette A palette function that when called with a single integer
 #'   argument (the number of levels in the scale) returns the numerical values

R/scale-gradient.R

@@ -16,7 +16,7 @@
 #' @param low,high Colours for low and high ends of the gradient.
 #' @param guide Type of legend. Use `"colourbar"` for continuous
 #'   colour bar, or `"legend"` for discrete colour legend.
-#' @inheritDotParams continuous_scale -na.value -guide -aesthetics -expand -position -palette
+#' @inheritDotParams continuous_scale -na.value -guide -aesthetics -expand -position -palette -fallback.palette
 #' @seealso [scales::pal_seq_gradient()] for details on underlying
 #'   palette, [scale_colour_steps()] for binned variants of these scales.
 #'

R/scale-grey.R

@@ -5,7 +5,7 @@
 #'
 #' @inheritParams scales::pal_grey
 #' @inheritParams scale_colour_hue
-#' @inheritDotParams discrete_scale -expand -position -scale_name -palette
+#' @inheritDotParams discrete_scale -expand -position -scale_name -palette -fallback.palette
 #' @family colour scales
 #' @seealso
 #' The documentation on [colour aesthetics][aes_colour_fill_alpha].

R/scale-hue.R

@@ -4,7 +4,7 @@
 #' It does not generate colour-blind safe palettes.
 #'
 #' @param na.value Colour to use for missing values
-#' @inheritDotParams discrete_scale -aesthetics -expand -position -scale_name -palette
+#' @inheritDotParams discrete_scale -aesthetics -expand -position -scale_name -palette -fallback.palette
 #' @param aesthetics Character string or vector of character strings listing the
 #'   name(s) of the aesthetic(s) that this scale works with. This can be useful, for
 #'   example, to apply colour settings to the `colour` and `fill` aesthetics at the

R/scale-linetype.R

@@ -6,7 +6,7 @@
 #' no inherent order, this use is not advised.
 #'
 #' @inheritParams discrete_scale
-#' @inheritDotParams discrete_scale -expand -position -na.value -scale_name -palette
+#' @inheritDotParams discrete_scale -expand -position -na.value -scale_name -palette -fallback.palette
 #' @rdname scale_linetype
 #' @details
 #' Lines can be referred to by number, name or hex code. Contrary to base R

R/scale-manual.R

@@ -12,7 +12,7 @@
 #' of aesthetics provided via the `aesthetics` argument.
 #'
 #' @inheritParams discrete_scale
-#' @inheritDotParams discrete_scale -expand -position -aesthetics -palette -scale_name
+#' @inheritDotParams discrete_scale -expand -position -aesthetics -palette -scale_name -fallback.palette
 #' @param aesthetics Character string or vector of character strings listing the
 #'   name(s) of the aesthetic(s) that this scale works with. This can be useful, for
 #'   example, to apply colour settings to the `colour` and `fill` aesthetics at the

R/scale-shape.R

@@ -10,7 +10,7 @@
 #' @param solid Should the shapes be solid, `TRUE`, or hollow,
 #'   `FALSE`?
 #' @inheritParams discrete_scale
-#' @inheritDotParams discrete_scale -expand -position -scale_name -palette
+#' @inheritDotParams discrete_scale -expand -position -scale_name -palette -fallback.palette
 #' @rdname scale_shape
 #' @details
 #' Shapes can be referred to by number or name. Shapes in \[0, 20\] do not

R/scale-size.R

@@ -124,7 +124,7 @@ scale_size_ordinal <- function(name = waiver(), ..., range = NULL, aesthetics =
   )
 }
 
-#' @inheritDotParams continuous_scale -aesthetics -scale_name -palette -rescaler -expand -position
+#' @inheritDotParams continuous_scale -aesthetics -scale_name -palette -rescaler -expand -position -fallback.palette
 #' @param max_size Size of largest points.
 #' @export
 #' @rdname scale_size

R/scale-steps.R

@@ -13,7 +13,7 @@
 #' Munsell colour system.
 #'
 #' @inheritParams scale_colour_gradient
-#' @inheritDotParams binned_scale -aesthetics -scale_name -palette -na.value -guide -rescaler -expand -position
+#' @inheritDotParams binned_scale -aesthetics -scale_name -palette -na.value -guide -rescaler -expand -position -fallback.palette
 #'
 #' @seealso
 #' [scales::pal_seq_gradient()] for details on underlying palette,