From 61b48ba6ada5878e229f7a6d73bbce24411e95a3 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Wed, 11 Dec 2024 16:11:19 +0100 Subject: [PATCH 1/3] Fix link --- R/tm_a_pca.R | 2 +- R/tm_a_regression.R | 2 +- R/tm_data_table.R | 2 +- R/tm_g_association.R | 2 +- R/tm_g_bivariate.R | 2 +- R/tm_g_distribution.R | 2 +- R/tm_g_response.R | 2 +- R/tm_g_scatterplot.R | 2 +- R/tm_g_scatterplotmatrix.R | 2 +- R/tm_missing_data.R | 2 +- R/tm_outliers.R | 2 +- R/tm_t_crosstable.R | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/R/tm_a_pca.R b/R/tm_a_pca.R index c6a7fb55e..e5960be33 100644 --- a/R/tm_a_pca.R +++ b/R/tm_a_pca.R @@ -45,7 +45,7 @@ #' ``` #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_a_regression.R b/R/tm_a_regression.R index b9015c585..508c04d4b 100644 --- a/R/tm_a_regression.R +++ b/R/tm_a_regression.R @@ -50,7 +50,7 @@ #' - `plot` (`ggplot2`) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_data_table.R b/R/tm_data_table.R index 3cb2155a9..022026e7a 100644 --- a/R/tm_data_table.R +++ b/R/tm_data_table.R @@ -36,7 +36,7 @@ #' - `table` ([DT::datatable()]) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_g_association.R b/R/tm_g_association.R index ec4a116d3..f2c4f479e 100644 --- a/R/tm_g_association.R +++ b/R/tm_g_association.R @@ -31,7 +31,7 @@ #' - `plot` (`grob` created with [ggplot2::ggplotGrob()]) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_g_bivariate.R b/R/tm_g_bivariate.R index aaf9b9642..ae88491cc 100644 --- a/R/tm_g_bivariate.R +++ b/R/tm_g_bivariate.R @@ -53,7 +53,7 @@ #' - `plot` (`ggplot2`) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' #' @examplesShinylive diff --git a/R/tm_g_distribution.R b/R/tm_g_distribution.R index 8e84ed76a..1c7b5aa92 100644 --- a/R/tm_g_distribution.R +++ b/R/tm_g_distribution.R @@ -54,7 +54,7 @@ #' ``` #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_g_response.R b/R/tm_g_response.R index 85590ed9f..219463a55 100644 --- a/R/tm_g_response.R +++ b/R/tm_g_response.R @@ -46,7 +46,7 @@ #' - `plot` (`ggplot2`) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_g_scatterplot.R b/R/tm_g_scatterplot.R index 28d9b0bda..eaab0e1e5 100644 --- a/R/tm_g_scatterplot.R +++ b/R/tm_g_scatterplot.R @@ -37,7 +37,7 @@ #' - `plot` (`ggplot2`) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' #' @examplesShinylive diff --git a/R/tm_g_scatterplotmatrix.R b/R/tm_g_scatterplotmatrix.R index ae1be8198..37c4899d7 100644 --- a/R/tm_g_scatterplotmatrix.R +++ b/R/tm_g_scatterplotmatrix.R @@ -25,7 +25,7 @@ #' - `plot` (`trellis` - output of `lattice::splom`) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_missing_data.R b/R/tm_missing_data.R index f3309c802..bd49368e7 100644 --- a/R/tm_missing_data.R +++ b/R/tm_missing_data.R @@ -45,7 +45,7 @@ #' ``` #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_outliers.R b/R/tm_outliers.R index 28473f6c9..4fc3ba7b4 100644 --- a/R/tm_outliers.R +++ b/R/tm_outliers.R @@ -43,7 +43,7 @@ #' ``` #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) diff --git a/R/tm_t_crosstable.R b/R/tm_t_crosstable.R index 5c8621fc3..9c8737fa6 100644 --- a/R/tm_t_crosstable.R +++ b/R/tm_t_crosstable.R @@ -32,7 +32,7 @@ #' - `table` (`ElementaryTable` - output of `rtables::build_table`) #' #' For additional details and examples of decorators, refer to the vignette -#' `vignette("decorate-modules-output", package = "teal")` or the [`teal_transform_module()`] documentation. +#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation. #' #' @examplesShinylive #' library(teal.modules.general) From c37b3801921da65b113b38ba4d1ef4d3941eb12c Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Llu=C3=ADs=20Revilla?= Date: Wed, 11 Dec 2024 16:14:34 +0100 Subject: [PATCH 2/3] Document new links --- man/tm_a_pca.Rd | 2 +- man/tm_a_regression.Rd | 2 +- man/tm_data_table.Rd | 2 +- man/tm_g_association.Rd | 2 +- man/tm_g_bivariate.Rd | 2 +- man/tm_g_distribution.Rd | 6 +++--- man/tm_g_response.Rd | 2 +- man/tm_g_scatterplot.Rd | 2 +- man/tm_g_scatterplotmatrix.Rd | 2 +- man/tm_missing_data.Rd | 2 +- man/tm_outliers.Rd | 2 +- man/tm_t_crosstable.Rd | 2 +- 12 files changed, 14 insertions(+), 14 deletions(-) diff --git a/man/tm_a_pca.Rd b/man/tm_a_pca.Rd index 101f5d6e6..99ac47867 100644 --- a/man/tm_a_pca.Rd +++ b/man/tm_a_pca.Rd @@ -116,7 +116,7 @@ See code snippet below: }\if{html}{\out{}} For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_a_regression.Rd b/man/tm_a_regression.Rd index cd4621cc6..818a0e841 100644 --- a/man/tm_a_regression.Rd +++ b/man/tm_a_regression.Rd @@ -124,7 +124,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_data_table.Rd b/man/tm_data_table.Rd index ca1db1ea6..7c9e5fe4e 100644 --- a/man/tm_data_table.Rd +++ b/man/tm_data_table.Rd @@ -77,7 +77,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_g_association.Rd b/man/tm_g_association.Rd index 4ca13c313..bc0e37728 100644 --- a/man/tm_g_association.Rd +++ b/man/tm_g_association.Rd @@ -84,7 +84,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_g_bivariate.Rd b/man/tm_g_bivariate.Rd index 177b714a1..e02d5ef16 100644 --- a/man/tm_g_bivariate.Rd +++ b/man/tm_g_bivariate.Rd @@ -131,7 +131,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_g_distribution.Rd b/man/tm_g_distribution.Rd index 680958fc6..a938d3c55 100644 --- a/man/tm_g_distribution.Rd +++ b/man/tm_g_distribution.Rd @@ -58,10 +58,10 @@ Defaults to \code{c(30L, 1L, 100L)}. \item{plot_width}{(\code{numeric}) optional, specifies the plot width as a three-element vector of \code{value}, \code{min}, and \code{max} for a slider encoding the plot width.} -\item{pre_output}{(\code{shiny.tag}, optional)\cr +\item{pre_output}{(\code{shiny.tag}) optional,\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{(\code{shiny.tag}, optional) with text placed after the output to put the output +\item{post_output}{(\code{shiny.tag}) optional, with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} \item{decorators}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} (\code{list} of \code{teal_transform_module}, named \code{list} of \code{teal_transform_module} or \code{NULL}) optional, if not \code{NULL}, decorator for tables or plots included in the module. When a named list of \code{teal_transform_module}, the decorators are applied to the respective output objects. @@ -107,7 +107,7 @@ See code snippet below: }\if{html}{\out{}} For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_g_response.Rd b/man/tm_g_response.Rd index e5454501b..c8d53f14a 100644 --- a/man/tm_g_response.Rd +++ b/man/tm_g_response.Rd @@ -112,7 +112,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_g_scatterplot.Rd b/man/tm_g_scatterplot.Rd index 4f90024f2..a68d7eee9 100644 --- a/man/tm_g_scatterplot.Rd +++ b/man/tm_g_scatterplot.Rd @@ -123,7 +123,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_g_scatterplotmatrix.Rd b/man/tm_g_scatterplotmatrix.Rd index a0af16a82..b0dcca28e 100644 --- a/man/tm_g_scatterplotmatrix.Rd +++ b/man/tm_g_scatterplotmatrix.Rd @@ -63,7 +63,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_missing_data.Rd b/man/tm_missing_data.Rd index c6cd75b96..b28eaf245 100644 --- a/man/tm_missing_data.Rd +++ b/man/tm_missing_data.Rd @@ -91,7 +91,7 @@ See code snippet below: }\if{html}{\out{}} For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_outliers.Rd b/man/tm_outliers.Rd index 106ba0ec4..473f92ac5 100644 --- a/man/tm_outliers.Rd +++ b/man/tm_outliers.Rd @@ -91,7 +91,7 @@ See code snippet below: }\if{html}{\out{}} For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ diff --git a/man/tm_t_crosstable.Rd b/man/tm_t_crosstable.Rd index dc3ab1578..c8d5c7d4b 100644 --- a/man/tm_t_crosstable.Rd +++ b/man/tm_t_crosstable.Rd @@ -77,7 +77,7 @@ This module generates the following objects, which can be modified in place usin } For additional details and examples of decorators, refer to the vignette -\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[=teal_transform_module]{teal_transform_module()}} documentation. +\code{vignette("decorate-modules-output", package = "teal")} or the \code{\link[teal:teal_transform_module]{teal::teal_transform_module()}} documentation. } \examples{ From 59f00e04a0c59bf3a5c37dbca42352f88eeecb80 Mon Sep 17 00:00:00 2001 From: github-actions <41898282+github-actions[bot]@users.noreply.github.com> Date: Wed, 11 Dec 2024 15:32:41 +0000 Subject: [PATCH 3/3] [skip roxygen] [skip vbump] Roxygen Man Pages Auto Update --- man/tm_g_distribution.Rd | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/man/tm_g_distribution.Rd b/man/tm_g_distribution.Rd index a938d3c55..9a55dbbde 100644 --- a/man/tm_g_distribution.Rd +++ b/man/tm_g_distribution.Rd @@ -58,10 +58,10 @@ Defaults to \code{c(30L, 1L, 100L)}. \item{plot_width}{(\code{numeric}) optional, specifies the plot width as a three-element vector of \code{value}, \code{min}, and \code{max} for a slider encoding the plot width.} -\item{pre_output}{(\code{shiny.tag}) optional,\cr +\item{pre_output}{(\code{shiny.tag}, optional)\cr with text placed before the output to put the output into context. For example a title.} -\item{post_output}{(\code{shiny.tag}) optional, with text placed after the output to put the output +\item{post_output}{(\code{shiny.tag}, optional) with text placed after the output to put the output into context. For example the \code{\link[shiny:helpText]{shiny::helpText()}} elements are useful.} \item{decorators}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} (\code{list} of \code{teal_transform_module}, named \code{list} of \code{teal_transform_module} or \code{NULL}) optional, if not \code{NULL}, decorator for tables or plots included in the module. When a named list of \code{teal_transform_module}, the decorators are applied to the respective output objects.