diff --git a/R/scale-.R b/R/scale-.R index 4bf54328b3..a0c616bafc 100644 --- a/R/scale-.R +++ b/R/scale-.R @@ -34,7 +34,9 @@ #' may choose a slightly different number to ensure nice break labels. Will #' only have an effect if `breaks = waiver()`. Use `NULL` to use the default #' number of breaks given by the transformation. -#' @param labels One of: +#' @param labels One of the options below. Please note that when `labels` is a +#' vector, it is highly recommended to also set the `breaks` argument as a +#' vector to protect against unintended mismatches. #' - `NULL` for no labels #' - `waiver()` for the default labels computed by the #' transformation object diff --git a/man/binned_scale.Rd b/man/binned_scale.Rd index c1bbd50404..203cd66bb4 100644 --- a/man/binned_scale.Rd +++ b/man/binned_scale.Rd @@ -55,7 +55,9 @@ Note that for position scales, limits are provided after scale expansion. Also accepts rlang \link[rlang:as_function]{lambda} function notation. }} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/continuous_scale.Rd b/man/continuous_scale.Rd index a572ec2bf7..76d7492ba6 100644 --- a/man/continuous_scale.Rd +++ b/man/continuous_scale.Rd @@ -70,7 +70,9 @@ may choose a slightly different number to ensure nice break labels. Will only have an effect if \code{breaks = waiver()}. Use \code{NULL} to use the default number of breaks given by the transformation.} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/datetime_scale.Rd b/man/datetime_scale.Rd index d0a1afeec2..c843dc0706 100644 --- a/man/datetime_scale.Rd +++ b/man/datetime_scale.Rd @@ -61,7 +61,9 @@ values between 0 and 1 returns the corresponding output values output }} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/discrete_scale.Rd b/man/discrete_scale.Rd index ae349cdf1f..cf76226a67 100644 --- a/man/discrete_scale.Rd +++ b/man/discrete_scale.Rd @@ -60,7 +60,9 @@ the function has two arguments, it will be given the limits and major break positions. }} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_binned.Rd b/man/scale_binned.Rd index ad98d61969..f75f8a16f9 100644 --- a/man/scale_binned.Rd +++ b/man/scale_binned.Rd @@ -68,7 +68,9 @@ Note that for position scales, limits are provided after scale expansion. Also accepts rlang \link[rlang:as_function]{lambda} function notation. }} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_continuous.Rd b/man/scale_continuous.Rd index 153bb325f5..5fa4a0fb44 100644 --- a/man/scale_continuous.Rd +++ b/man/scale_continuous.Rd @@ -92,7 +92,9 @@ may choose a slightly different number to ensure nice break labels. Will only have an effect if \code{breaks = waiver()}. Use \code{NULL} to use the default number of breaks given by the transformation.} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_date.Rd b/man/scale_date.Rd index 86c82e0271..bce3946d9a 100644 --- a/man/scale_date.Rd +++ b/man/scale_date.Rd @@ -122,7 +122,9 @@ weeks", or "10 years". If both \code{breaks} and \code{date_breaks} are specified, \code{date_breaks} wins. Valid specifications are 'sec', 'min', 'hour', 'day', 'week', 'month' or 'year', optionally followed by 's'.} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_discrete.Rd b/man/scale_discrete.Rd index 0bab3ad985..4891201e57 100644 --- a/man/scale_discrete.Rd +++ b/man/scale_discrete.Rd @@ -74,7 +74,9 @@ accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major break positions. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_gradient.Rd b/man/scale_gradient.Rd index 619e71f3ef..6d0b5c8c15 100644 --- a/man/scale_gradient.Rd +++ b/man/scale_gradient.Rd @@ -129,7 +129,9 @@ break positions. may choose a slightly different number to ensure nice break labels. Will only have an effect if \code{breaks = waiver()}. Use \code{NULL} to use the default number of breaks given by the transformation.} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_grey.Rd b/man/scale_grey.Rd index 0ee97a15de..9d838508dc 100644 --- a/man/scale_grey.Rd +++ b/man/scale_grey.Rd @@ -69,7 +69,9 @@ accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major break positions. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_hue.Rd b/man/scale_hue.Rd index 1280e741bb..0a0aba8fcd 100644 --- a/man/scale_hue.Rd +++ b/man/scale_hue.Rd @@ -75,7 +75,9 @@ accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major break positions. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_linetype.Rd b/man/scale_linetype.Rd index cc5fa67cb4..cc1a4c09f4 100644 --- a/man/scale_linetype.Rd +++ b/man/scale_linetype.Rd @@ -61,7 +61,9 @@ accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major break positions. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_linewidth.Rd b/man/scale_linewidth.Rd index 5c9a842da9..bd39908725 100644 --- a/man/scale_linewidth.Rd +++ b/man/scale_linewidth.Rd @@ -52,7 +52,9 @@ Note that for position scales, limits are provided after scale expansion. Also accepts rlang \link[rlang:as_function]{lambda} function notation. }} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_manual.Rd b/man/scale_manual.Rd index d49cd0f526..7cf52a4d9d 100644 --- a/man/scale_manual.Rd +++ b/man/scale_manual.Rd @@ -75,7 +75,9 @@ accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major break positions. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_shape.Rd b/man/scale_shape.Rd index 85b991fd9a..d79ae7f586 100644 --- a/man/scale_shape.Rd +++ b/man/scale_shape.Rd @@ -61,7 +61,9 @@ accepts rlang \link[rlang:as_function]{lambda} function notation. When the function has two arguments, it will be given the limits and major break positions. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_size.Rd b/man/scale_size.Rd index 2ba6a1e295..be8db0a8eb 100644 --- a/man/scale_size.Rd +++ b/man/scale_size.Rd @@ -70,7 +70,9 @@ Note that for position scales, limits are provided after scale expansion. Also accepts rlang \link[rlang:as_function]{lambda} function notation. }} -\item{labels}{One of: +\item{labels}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the diff --git a/man/scale_steps.Rd b/man/scale_steps.Rd index 1206c159f9..9f6740a561 100644 --- a/man/scale_steps.Rd +++ b/man/scale_steps.Rd @@ -129,7 +129,9 @@ as output (e.g., a function returned by \code{\link[scales:breaks_extended]{scal Note that for position scales, limits are provided after scale expansion. Also accepts rlang \link[rlang:as_function]{lambda} function notation. }} - \item{\code{labels}}{One of: + \item{\code{labels}}{One of the options below. Please note that when \code{labels} is a +vector, it is highly recommended to also set the \code{breaks} argument as a +vector to protect against unintended mismatches. \itemize{ \item \code{NULL} for no labels \item \code{waiver()} for the default labels computed by the