diff --git a/R/scale-.R b/R/scale-.R index 97e2e8378e..d627e88498 100644 --- 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 `_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 `_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 index 40cd372207..6a64eb36d7 100644 --- a/man/binned_scale.Rd +++ b/man/binned_scale.Rd @@ -127,9 +127,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{show.limits}{should the limits of the scale appear as ticks} diff --git a/man/continuous_scale.Rd b/man/continuous_scale.Rd index da41b1ee4e..677091357e 100644 --- a/man/continuous_scale.Rd +++ b/man/continuous_scale.Rd @@ -125,9 +125,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{guide}{A function used to create a guide or its name. See \code{\link[=guides]{guides()}} for more information.} diff --git a/man/scale_binned.Rd b/man/scale_binned.Rd index 0a729d0c6a..7949c45f13 100644 --- a/man/scale_binned.Rd +++ b/man/scale_binned.Rd @@ -126,9 +126,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{guide}{A function used to create a guide or its name. See \code{\link[=guides]{guides()}} for more information.} diff --git a/man/scale_continuous.Rd b/man/scale_continuous.Rd index 554e96f69e..f145e8c18a 100644 --- a/man/scale_continuous.Rd +++ b/man/scale_continuous.Rd @@ -140,9 +140,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{guide}{A function used to create a guide or its name. See \code{\link[=guides]{guides()}} for more information.} diff --git a/man/scale_gradient.Rd b/man/scale_gradient.Rd index a7e45e30cb..53dfc30a16 100644 --- a/man/scale_gradient.Rd +++ b/man/scale_gradient.Rd @@ -167,9 +167,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{\code{expand}}{For position scales, a vector of range expansion constants used to add some padding around the data to ensure that they are placed some distance away from the axes. Use the convenience function \code{\link[=expansion]{expansion()}} diff --git a/man/scale_linewidth.Rd b/man/scale_linewidth.Rd index b661926b3a..153ac04fdf 100644 --- a/man/scale_linewidth.Rd +++ b/man/scale_linewidth.Rd @@ -85,9 +85,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{guide}{A function used to create a guide or its name. See \code{\link[=guides]{guides()}} for more information.} diff --git a/man/scale_size.Rd b/man/scale_size.Rd index c80df3bcb3..304ceafa56 100644 --- a/man/scale_size.Rd +++ b/man/scale_size.Rd @@ -102,9 +102,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{guide}{A function used to create a guide or its name. See \code{\link[=guides]{guides()}} for more information.} diff --git a/man/scale_steps.Rd b/man/scale_steps.Rd index 7344adbb2c..3dcad65e49 100644 --- a/man/scale_steps.Rd +++ b/man/scale_steps.Rd @@ -150,9 +150,10 @@ or the object itself. Built-in transformations include "asn", "atanh", 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 \verb{_trans} (e.g., -\code{\link[scales:boxcox_trans]{scales::boxcox_trans()}}). You can create your own -transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} +are defined in the scales package, and are called \verb{_trans}. If +transformations require arguments, you can call them from the scales +package, e.g. \code{\link[scales:boxcox_trans]{scales::boxcox_trans(p = 2)}}. +You can create your own transformation with \code{\link[scales:trans_new]{scales::trans_new()}}.} \item{\code{expand}}{For position scales, a vector of range expansion constants used to add some padding around the data to ensure that they are placed some distance away from the axes. Use the convenience function \code{\link[=expansion]{expansion()}}