From 6ed6366dd2a00b972215d63708eea4f3d97a91df Mon Sep 17 00:00:00 2001 From: Yunuuuu Date: Wed, 18 Sep 2024 22:47:58 +0800 Subject: [PATCH] fix Docs --- R/activate.R | 5 ++--- man/align.Rd | 3 +-- man/align_dendro.Rd | 3 +-- man/align_gg.Rd | 3 +-- man/align_panel.Rd | 3 +-- man/hmanno.Rd | 5 ++--- man/stack_active.Rd | 5 ++--- 7 files changed, 10 insertions(+), 17 deletions(-) diff --git a/R/activate.R b/R/activate.R index 9232972e..6c8ec4c5 100644 --- a/R/activate.R +++ b/R/activate.R @@ -14,7 +14,7 @@ #' @param width,height Heatmap body width/height, can be a [unit][grid::unit] #' object. Only used when `position` is `NULL`. #' @param guides A boolean value or a string containing one or more of -#' `r rd_values(.tlbr)` indicates Which guide should be collected. If `NULL`, no +#' `r rd_values(.tlbr)` indicates which guide should be collected. If `NULL`, no #' guides will be collected. Default: "tlbr". #' @param free_labs A boolean value or a string containing one or more of #' `r rd_values(.tlbr)` indicates which axis title should be free from @@ -24,8 +24,7 @@ #' `NULL` (default), no space will be removed. #' @param plot_data A function used to transform the plot data before rendering. #' By default, it'll inherit from the parent layout. If no parent layout, the -#' default is to not modify the data. Use `NULL`, if you don't want to modify -#' anything. +#' default is `NULL`, which means we won't want to modify anything. #' #' Used to modify the data after layout has been created, but before the data is #' handled of to the ggplot2 for rendering. Use this hook if the you needs diff --git a/man/align.Rd b/man/align.Rd index c838ff76..403cc8e3 100644 --- a/man/align.Rd +++ b/man/align.Rd @@ -54,8 +54,7 @@ alignment. If \code{NULL}, all axis title will be aligned. Default: "tlbr".} \item{plot_data}{A function used to transform the plot data before rendering. By default, it'll inherit from the parent layout. If no parent layout, the -default is to not modify the data. Use \code{NULL}, if you don't want to modify -anything. +default is \code{NULL}, which means we won't want to modify anything. Used to modify the data after layout has been created, but before the data is handled of to the ggplot2 for rendering. Use this hook if the you needs diff --git a/man/align_dendro.Rd b/man/align_dendro.Rd index 60e6193e..9255d571 100644 --- a/man/align_dendro.Rd +++ b/man/align_dendro.Rd @@ -104,8 +104,7 @@ alignment. If \code{NULL}, all axis title will be aligned. Default: "tlbr".} \item{plot_data}{A function used to transform the plot data before rendering. By default, it'll inherit from the parent layout. If no parent layout, the -default is to not modify the data. Use \code{NULL}, if you don't want to modify -anything. +default is \code{NULL}, which means we won't want to modify anything. Used to modify the data after layout has been created, but before the data is handled of to the ggplot2 for rendering. Use this hook if the you needs diff --git a/man/align_gg.Rd b/man/align_gg.Rd index e2107659..8cba9777 100644 --- a/man/align_gg.Rd +++ b/man/align_gg.Rd @@ -66,8 +66,7 @@ alignment. If \code{NULL}, all axis title will be aligned. Default: "tlbr".} \item{plot_data}{A function used to transform the plot data before rendering. By default, it'll inherit from the parent layout. If no parent layout, the -default is to not modify the data. Use \code{NULL}, if you don't want to modify -anything. +default is \code{NULL}, which means we won't want to modify anything. Used to modify the data after layout has been created, but before the data is handled of to the ggplot2 for rendering. Use this hook if the you needs diff --git a/man/align_panel.Rd b/man/align_panel.Rd index d48a2878..a831e90f 100644 --- a/man/align_panel.Rd +++ b/man/align_panel.Rd @@ -46,8 +46,7 @@ alignment. If \code{NULL}, all axis title will be aligned. Default: "tlbr".} \item{plot_data}{A function used to transform the plot data before rendering. By default, it'll inherit from the parent layout. If no parent layout, the -default is to not modify the data. Use \code{NULL}, if you don't want to modify -anything. +default is \code{NULL}, which means we won't want to modify anything. Used to modify the data after layout has been created, but before the data is handled of to the ggplot2 for rendering. Use this hook if the you needs diff --git a/man/hmanno.Rd b/man/hmanno.Rd index da43aff9..4a18c24e 100644 --- a/man/hmanno.Rd +++ b/man/hmanno.Rd @@ -39,7 +39,7 @@ annotation. object. Only used when \code{position} is \code{NULL}.} \item{guides}{A boolean value or a string containing one or more of -\code{"t"}, \code{"l"}, \code{"b"}, and \code{"r"} indicates Which guide should be collected. If \code{NULL}, no +\code{"t"}, \code{"l"}, \code{"b"}, and \code{"r"} indicates which guide should be collected. If \code{NULL}, no guides will be collected. Default: "tlbr".} \item{free_labs}{A boolean value or a string containing one or more of @@ -52,8 +52,7 @@ alignment. If \code{NULL}, all axis title will be aligned. Default: "tlbr".} \item{plot_data}{A function used to transform the plot data before rendering. By default, it'll inherit from the parent layout. If no parent layout, the -default is to not modify the data. Use \code{NULL}, if you don't want to modify -anything. +default is \code{NULL}, which means we won't want to modify anything. Used to modify the data after layout has been created, but before the data is handled of to the ggplot2 for rendering. Use this hook if the you needs diff --git a/man/stack_active.Rd b/man/stack_active.Rd index 8b57926b..3e1446d9 100644 --- a/man/stack_active.Rd +++ b/man/stack_active.Rd @@ -19,7 +19,7 @@ stack_active( the relative widths (\code{direction = "horizontal"}) / heights (\code{direction = "vertical"}).} \item{guides}{A boolean value or a string containing one or more of -\code{"t"}, \code{"l"}, \code{"b"}, and \code{"r"} indicates Which guide should be collected. If \code{NULL}, no +\code{"t"}, \code{"l"}, \code{"b"}, and \code{"r"} indicates which guide should be collected. If \code{NULL}, no guides will be collected. Default: "tlbr".} \item{free_labs}{A boolean value or a string containing one or more of @@ -32,8 +32,7 @@ alignment. If \code{NULL}, all axis title will be aligned. Default: "tlbr".} \item{plot_data}{A function used to transform the plot data before rendering. By default, it'll inherit from the parent layout. If no parent layout, the -default is to not modify the data. Use \code{NULL}, if you don't want to modify -anything. +default is \code{NULL}, which means we won't want to modify anything. Used to modify the data after layout has been created, but before the data is handled of to the ggplot2 for rendering. Use this hook if the you needs