Skip to content

Commit 0a09bf7

Browse files
committed
vignette on decorators
1 parent 389fe09 commit 0a09bf7

29 files changed

+436
-113
lines changed

R/tm_a_pca.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@
4343
#' )
4444
#' ```
4545
#'
46-
#' For additional details and examples of decorators, refer to the vignette
47-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
46+
#' For additional details and examples of decorators, refer to the vignettes:
47+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
48+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
4849
#'
4950
#' @examplesShinylive
5051
#' library(teal.modules.general)

R/tm_a_regression.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,9 @@
4848
#' This module generates the following objects, which can be modified in place using decorators:
4949
#' - `plot` (`ggplot2`)
5050
#'
51-
#' For additional details and examples of decorators, refer to the vignette
52-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
51+
#' For additional details and examples of decorators, refer to the vignettes:
52+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
53+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
5354
#'
5455
#' @examplesShinylive
5556
#' library(teal.modules.general)

R/tm_g_association.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,9 @@
2929
#' This module generates the following objects, which can be modified in place using decorators:
3030
#' - `plot` (`grob` created with [ggplot2::ggplotGrob()])
3131
#'
32-
#' For additional details and examples of decorators, refer to the vignette
33-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
32+
#' For additional details and examples of decorators, refer to the vignettes:
33+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
34+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
3435
#'
3536
#' @examplesShinylive
3637
#' library(teal.modules.general)

R/tm_g_bivariate.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,8 +51,9 @@
5151
#' This module generates the following objects, which can be modified in place using decorators:
5252
#' - `plot` (`ggplot2`)
5353
#'
54-
#' For additional details and examples of decorators, refer to the vignette
55-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
54+
#' For additional details and examples of decorators, refer to the vignettes:
55+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
56+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
5657
#'
5758
#'
5859
#' @examplesShinylive

R/tm_g_distribution.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,9 @@
5252
#' )
5353
#' ```
5454
#'
55-
#' For additional details and examples of decorators, refer to the vignette
56-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
55+
#' For additional details and examples of decorators, refer to the vignettes:
56+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
57+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
5758
#'
5859
#' @examplesShinylive
5960
#' library(teal.modules.general)

R/tm_g_response.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,9 @@
4444
#' This module generates the following objects, which can be modified in place using decorators:
4545
#' - `plot` (`ggplot2`)
4646
#'
47-
#' For additional details and examples of decorators, refer to the vignette
48-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
47+
#' For additional details and examples of decorators, refer to the vignettes:
48+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
49+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
4950
#'
5051
#' @examplesShinylive
5152
#' library(teal.modules.general)

R/tm_g_scatterplot.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,8 +35,9 @@
3535
#' This module generates the following objects, which can be modified in place using decorators:
3636
#' - `plot` (`ggplot2`)
3737
#'
38-
#' For additional details and examples of decorators, refer to the vignette
39-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
38+
#' For additional details and examples of decorators, refer to the vignettes:
39+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
40+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
4041
#'
4142
#'
4243
#' @examplesShinylive

R/tm_g_scatterplotmatrix.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,9 @@
2323
#' This module generates the following objects, which can be modified in place using decorators:
2424
#' - `plot` (`trellis` - output of `lattice::splom`)
2525
#'
26-
#' For additional details and examples of decorators, refer to the vignette
27-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
26+
#' For additional details and examples of decorators, refer to the vignettes:
27+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
28+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
2829
#'
2930
#' @examplesShinylive
3031
#' library(teal.modules.general)

R/tm_missing_data.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,9 @@
4343
#' )
4444
#' ```
4545
#'
46-
#' For additional details and examples of decorators, refer to the vignette
47-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
46+
#' For additional details and examples of decorators, refer to the vignettes:
47+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
48+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
4849
#'
4950
#' @examplesShinylive
5051
#' library(teal.modules.general)

R/tm_outliers.R

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -41,8 +41,9 @@
4141
#' )
4242
#' ```
4343
#'
44-
#' For additional details and examples of decorators, refer to the vignette
45-
#' `vignette("decorate-modules-output", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
44+
#' For additional details and examples of decorators, refer to the vignettes:
45+
#' `vignette("customizing-module-output, package = "teal.modules.general")`,
46+
#' `vignette("TODO to be added", package = "teal")` or the [`teal::teal_transform_module()`] documentation.
4647
#'
4748
#' @examplesShinylive
4849
#' library(teal.modules.general)

0 commit comments

Comments
 (0)