Passing parameters to trans argument (#5361)

tidyverse · Aug 1, 2023 · af4cc02 · af4cc02
1 parent d21ac51
commit af4cc02
Show file tree

Hide file tree

Showing 9 changed files with 36 additions and 27 deletions.
diff --git a/R/scale-.R b/R/scale-.R
@@ -73,9 +73,10 @@
 #'
 #' 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()].
+#' are defined in the scales package, and are called `<name>_trans`. If
+#' transformations require arguments, you can call them from the scales
+#' package, e.g. [`scales::boxcox_trans(p = 2)`][scales::boxcox_trans].
+#' You can create your own transformation with [scales::trans_new()].
 #' @param guide A function used to create a guide or its name. See
 #' [guides()] for more information.
 #' @param expand For position scales, a vector of range expansion constants used to add some

diff --git a/man/binned_scale.Rd b/man/binned_scale.Rd
diff --git a/man/continuous_scale.Rd b/man/continuous_scale.Rd
diff --git a/man/scale_binned.Rd b/man/scale_binned.Rd
diff --git a/man/scale_continuous.Rd b/man/scale_continuous.Rd
diff --git a/man/scale_gradient.Rd b/man/scale_gradient.Rd
diff --git a/man/scale_linewidth.Rd b/man/scale_linewidth.Rd
diff --git a/man/scale_size.Rd b/man/scale_size.Rd
diff --git a/man/scale_steps.Rd b/man/scale_steps.Rd