From 6bb61dcf25e4ae03c6a8fd254e894623b1f10a0d Mon Sep 17 00:00:00 2001 From: yun Date: Sat, 3 Aug 2024 23:44:46 +0800 Subject: [PATCH] docs --- R/layout-stack-.R | 3 ++- man/layout_stack.Rd | 4 +--- 2 files changed, 3 insertions(+), 4 deletions(-) diff --git a/R/layout-stack-.R b/R/layout-stack-.R index 8a04b342..a1b183d7 100644 --- a/R/layout-stack-.R +++ b/R/layout-stack-.R @@ -4,7 +4,7 @@ #' #' `ggstack` is an alias of `layout_stack`. #' -#' @inheritParams layout_heatmap +#' @param data A numeric or character vector, a data frame, or a matrix. #' @param direction A string of `"horizontal"` or `"vertical"`, indicates the #' direction of the stack layout. #' @param labels,labels_nudge Default `labels`/`labels_nudge` for axis @@ -12,6 +12,7 @@ #' @param rel_sizes A numeric or [unit][grid::unit] object of length `3` #' indicates the relative widths (`direction = "vertical"`) / heights #' (`direction = "vertical"`). +#' @inheritParams layout_heatmap #' @return A `LayoutStack` object. #' @export layout_stack <- function(data, direction = NULL, diff --git a/man/layout_stack.Rd b/man/layout_stack.Rd index 81005a2a..b17c3100 100644 --- a/man/layout_stack.Rd +++ b/man/layout_stack.Rd @@ -24,9 +24,7 @@ ggstack( ) } \arguments{ -\item{data}{A numeric or character vector, a data frame, and any other data -which can be converted into a matrix. Simple vector will be converted into a -one column matrix.} +\item{data}{A numeric or character vector, a data frame, or a matrix.} \item{direction}{A string of \code{"horizontal"} or \code{"vertical"}, indicates the direction of the stack layout.}