From 3723255bbaf6069960164ad714b6accd33ac1d3a Mon Sep 17 00:00:00 2001 From: Matthew Kay Date: Tue, 2 Apr 2024 20:53:49 -0500 Subject: [PATCH] add missing doc --- R/subscale.R | 7 +++++++ man/subscale_thickness.Rd | 10 ++++++++++ 2 files changed, 17 insertions(+) diff --git a/R/subscale.R b/R/subscale.R index f2a18fe5..48f21992 100755 --- a/R/subscale.R +++ b/R/subscale.R @@ -7,6 +7,13 @@ #' #' @param x a [numeric] vector to be rescaled. #' Typically provided automatically by [geom_slabinterval()]. +#' @param limits One of: +#' - `NULL` to use the range of the data +#' - A [numeric] vector of length two providing the limits of the scale. Use +#' `NA` to use the default minimum or maximum. +#' - A function that accepts a length-2 [numeric] vector of the automatic +#' limits and returns new limits. Unlike positional scales. Unlike +#' positional scales, these limits will not remove data. #' @param expand A numeric vector of limit expansion constants of length #' 2 or 4, following the same format used by the `expand` argument of #' [continuous_scale()]. The default is not to expand the limits. diff --git a/man/subscale_thickness.Rd b/man/subscale_thickness.Rd index 16e0505f..6247d242 100755 --- a/man/subscale_thickness.Rd +++ b/man/subscale_thickness.Rd @@ -14,6 +14,16 @@ subscale_thickness( \item{x}{a \link{numeric} vector to be rescaled. Typically provided automatically by \code{\link[=geom_slabinterval]{geom_slabinterval()}}.} +\item{limits}{One of: +\itemize{ +\item \code{NULL} to use the range of the data +\item A \link{numeric} vector of length two providing the limits of the scale. Use +\code{NA} to use the default minimum or maximum. +\item A function that accepts a length-2 \link{numeric} vector of the automatic +limits and returns new limits. Unlike positional scales. Unlike +positional scales, these limits will not remove data. +}} + \item{expand}{A numeric vector of limit expansion constants of length 2 or 4, following the same format used by the \code{expand} argument of \code{\link[=continuous_scale]{continuous_scale()}}. The default is not to expand the limits.