diff --git a/R/layout-stack-.R b/R/layout-stack-.R index 61d665f4..60056eda 100644 --- a/R/layout-stack-.R +++ b/R/layout-stack-.R @@ -8,9 +8,9 @@ #' #' Several aliases are provided for convenience: #' - `stack_discretev` and `stack_alignv`: A special case of `stack_discrete` -#' that sets `direction = "vertical"`. +#' that sets `direction = "v"`. #' - `stack_discreteh` and `stack_alignh`: A special case of `stack_discrete` -#' that sets `direction = "horizontal"`. +#' that sets `direction = "h"`. #' #' @param direction A string indicating the direction of the stack layout, #' either `"h"`(`horizontal`) or `"v"`(`vertical`). @@ -24,10 +24,10 @@ #' plots in the layout. #' #' @param sizes A numeric value or a [`unit`][grid::unit] object. When used for -#' the [`quad_layout()`] annotation, it must be of length `1`. When used in -#' the [`stack_layout()`] with a nested [`quad_layout()`], it should be of -#' length `3`, specifying the relative heights (for `direction = "horizontal"`) -#' or widths (for `direction = "vertical"`) to be applied to the layout. +#' the [`quad_layout()`] annotation, it must be of length `1`. When used in the +#' [`stack_layout()`] with a nested [`quad_layout()`], it should be of length +#' `3`, specifying the relative heights (for `direction = "h"`) or widths (for +#' `direction = "v"`) to be applied to the layout. #' #' @examples #' set.seed(123) @@ -110,9 +110,9 @@ stack_discrete.formula <- stack_discrete.function #' variables. The alias `stack_free` is retained for historical reasons. #' #' - `stack_continuousv()`/`stack_freev`: A special case of `stack_free` that -#' sets `direction = "vertical"`. +#' sets `direction = "v"`. #' - `stack_continuoush()`/`stack_freeh`: A special case of `stack_free` that -#' sets `direction = "horizontal"`. +#' sets `direction = "h"`. #' #' @param data `r rd_layout_data()`, [`fortify_data_frame()`] will be used to #' convert data to a data frame. Note that if the data is a `matrix`, it will diff --git a/man/stack_continuous.Rd b/man/stack_continuous.Rd index 5c012ef2..99be496d 100644 --- a/man/stack_continuous.Rd +++ b/man/stack_continuous.Rd @@ -57,10 +57,10 @@ inherit from the parent \code{layout}. It also controls the panel spacing for al plots in the layout.} \item{sizes}{A numeric value or a \code{\link[grid:unit]{unit}} object. When used for -the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in -the \code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of -length \code{3}, specifying the relative heights (for \code{direction = "horizontal"}) -or widths (for \code{direction = "vertical"}) to be applied to the layout.} +the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in the +\code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of length +\code{3}, specifying the relative heights (for \code{direction = "h"}) or widths (for +\code{direction = "v"}) to be applied to the layout.} } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} @@ -69,8 +69,8 @@ The \code{stack_continuous} function arranges plots by aligning continuous variables. The alias \code{stack_free} is retained for historical reasons. \itemize{ \item \code{stack_continuousv()}/\code{stack_freev}: A special case of \code{stack_free} that -sets \code{direction = "vertical"}. +sets \code{direction = "v"}. \item \code{stack_continuoush()}/\code{stack_freeh}: A special case of \code{stack_free} that -sets \code{direction = "horizontal"}. +sets \code{direction = "h"}. } } diff --git a/man/stack_cross.Rd b/man/stack_cross.Rd index 2883b978..0aea1797 100644 --- a/man/stack_cross.Rd +++ b/man/stack_cross.Rd @@ -28,10 +28,10 @@ inherit from the parent \code{layout}. It also controls the panel spacing for al plots in the layout.} \item{sizes}{A numeric value or a \code{\link[grid:unit]{unit}} object. When used for -the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in -the \code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of -length \code{3}, specifying the relative heights (for \code{direction = "horizontal"}) -or widths (for \code{direction = "vertical"}) to be applied to the layout.} +the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in the +\code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of length +\code{3}, specifying the relative heights (for \code{direction = "h"}) or widths (for +\code{direction = "v"}) to be applied to the layout.} } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} diff --git a/man/stack_discrete.Rd b/man/stack_discrete.Rd index 1a87633c..cc9feec2 100644 --- a/man/stack_discrete.Rd +++ b/man/stack_discrete.Rd @@ -37,10 +37,10 @@ inherit from the parent \code{layout}. It also controls the panel spacing for al plots in the layout.} \item{sizes}{A numeric value or a \code{\link[grid:unit]{unit}} object. When used for -the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in -the \code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of -length \code{3}, specifying the relative heights (for \code{direction = "horizontal"}) -or widths (for \code{direction = "vertical"}) to be applied to the layout.} +the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in the +\code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of length +\code{3}, specifying the relative heights (for \code{direction = "h"}) or widths (for +\code{direction = "v"}) to be applied to the layout.} } \description{ \ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#stable}{\figure{lifecycle-stable.svg}{options: alt='[Stable]'}}}{\strong{[Stable]}} @@ -51,9 +51,9 @@ The \code{stack_discrete} function arranges plots by aligning discrete variables Several aliases are provided for convenience: \itemize{ \item \code{stack_discretev} and \code{stack_alignv}: A special case of \code{stack_discrete} -that sets \code{direction = "vertical"}. +that sets \code{direction = "v"}. \item \code{stack_discreteh} and \code{stack_alignh}: A special case of \code{stack_discrete} -that sets \code{direction = "horizontal"}. +that sets \code{direction = "h"}. } } \examples{ diff --git a/man/stack_switch.Rd b/man/stack_switch.Rd index 579ce874..d8eaa421 100644 --- a/man/stack_switch.Rd +++ b/man/stack_switch.Rd @@ -11,10 +11,10 @@ stack_active(sizes = NULL, ...) } \arguments{ \item{sizes}{A numeric value or a \code{\link[grid:unit]{unit}} object. When used for -the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in -the \code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of -length \code{3}, specifying the relative heights (for \code{direction = "horizontal"}) -or widths (for \code{direction = "vertical"}) to be applied to the layout.} +the \code{\link[=quad_layout]{quad_layout()}} annotation, it must be of length \code{1}. When used in the +\code{\link[=stack_layout]{stack_layout()}} with a nested \code{\link[=quad_layout]{quad_layout()}}, it should be of length +\code{3}, specifying the relative heights (for \code{direction = "h"}) or widths (for +\code{direction = "v"}) to be applied to the layout.} \item{what}{What should get activated for the stack layout? A single number or string of the plot elements in the layout. If \code{NULL}, will remove any active context, this is useful when the active context is a