improve vignettes for transformers and decorators (#1476)

Some improvements.

---------

Signed-off-by: Aleksander Chlebowski <[email protected]>
Co-authored-by: Dawid Kałędkowski <[email protected]>
Co-authored-by: vedhav <[email protected]>

Author: 3 people

R/dummy_functions.R

@@ -5,7 +5,7 @@
 #' This module creates an object called `object` that can be modified with decorators.
 #' The `object` is determined by what's selected in `Choose a dataset` input in UI.
 #' The object can be anything that can be handled by `renderPrint()`.
-#' See the `vignette("decorate-modules-output", package = "teal")` or [`teal_transform_module`]
+#' See the `vignette("customizing-module-output", package = "teal")` or [`teal_transform_module`]
 #' to read more about decorators.
 #'
 #' @inheritParams teal_modules

R/modules.R

@@ -22,7 +22,7 @@ setOldClass("teal_modules")
 #'
 #' # Restricting datasets used by `teal_module`:
 #'
-#' The `datanames` argument controls which datasets are used by the module’s server. These datasets,
+#' The `datanames` argument controls which datasets are used by the module's server. These datasets,
 #' passed via server's `data` argument, are the only ones shown in the module's tab.
 #'
 #' When `datanames` is set to `"all"`, all datasets in the data object are treated as relevant.
@@ -35,7 +35,7 @@ setOldClass("teal_modules")
 #' Please see the _"Hidden datasets"_ section in `vignette("including-data-in-teal-applications").
 #'
 #' # `datanames` with `transformators`
-#' When transformators are specified, their `datanames` are added to the module’s `datanames`, which
+#' When transformators are specified, their `datanames` are added to the module's `datanames`, which
 #' changes the behavior as follows:
 #' - If `module(datanames)` is `NULL` and the `transformators` have defined `datanames`, the sidebar
 #'   will appear showing the `transformators`' datasets, instead of being hidden.

R/teal_transform_module.R

@@ -23,7 +23,7 @@
 #' To manage these `decorators` within your module, use [`ui_transform_teal_data()`] and [`srv_transform_teal_data()`].
 #' (For further guidance on managing decorators, refer to `ui_args` and `srv_args` in the vignette documentation.)
 #'
-#' See the vignette `vignette("decorate-modules-output", package = "teal")` for additional examples.
+#' See the vignette `vignette("customizing-module-output", package = "teal")` for additional examples.
 #'
 #' # `server` as a language
 #'

_pkgdown.yml

@@ -72,12 +72,12 @@ articles:
   - title: Using `teal`
     navbar: Using `teal`
     contents:
-      - teal-as-a-module
+      - teal-as-a-shiny-module
       - teal-options
       - bootstrap-themes-in-teal
   - title: 📃 Technical blueprint
     desc: >
-      The purpose of the blueprint is to aid new developer’s comprehension of the
+      The purpose of the blueprint is to aid new developer's comprehension of the
       fundamental principles of the `teal` framework. We will explore crucial `teal`
       concepts such as data flow, actors, and filter panel, among others.
     contents:

inst/WORDLIST

@@ -5,7 +5,6 @@ Hoffmann
 MAEs
 ORCID
 Reproducibility
-Shiny's
 Shinylive
 TLG
 UI

inst/design/teal-app-components-hover.drawio

@@ -39,6 +39,7 @@ interactive <- function() TRUE
 Let us consider an example module, based on the example module from `teal`:
 ```{r module_1}
 library(teal)
+library(teal.reporter)
 
 my_module <- function(label = "example teal module") {
   module(
@@ -138,6 +139,7 @@ if (interactive()) {
 ```{r shinylive_iframe_2, echo = FALSE, out.width = '150%', out.extra = 'style = "position: relative; z-index:1"', eval = requireNamespace("roxy.shinylive", quietly = TRUE) && knitr::is_html_output() && identical(Sys.getenv("IN_PKGDOWN"), "true")}
 code <- paste0(c(
   knitr::knit_code$get("as_interactive"),
+  knitr::knit_code$get("setup"),
   knitr::knit_code$get("module_2"),
   knitr::knit_code$get("app_2")
 ), collapse = "\n")
@@ -206,6 +208,7 @@ The user can now add a card to the report and view it in the `Report previewer`
 ```{r shinylive_iframe_3, echo = FALSE, out.width = '150%', out.extra = 'style = "position: relative; z-index:1"', eval = requireNamespace("roxy.shinylive", quietly = TRUE) && knitr::is_html_output() && identical(Sys.getenv("IN_PKGDOWN"), "true")}
 code <- paste0(c(
   knitr::knit_code$get("as_interactive"),
+  knitr::knit_code$get("setup"),
   knitr::knit_code$get("module_3"),
   knitr::knit_code$get("app_3")
 ), collapse = "\n")
@@ -278,6 +281,7 @@ Now, an application user can see the text added by `custom_function` in the `Rep
 ```{r shinylive_iframe_4, echo = FALSE, out.width = '150%', out.extra = 'style = "position: relative; z-index:1"', eval = requireNamespace("roxy.shinylive", quietly = TRUE) && knitr::is_html_output() && identical(Sys.getenv("IN_PKGDOWN"), "true")}
 code <- paste0(c(
   knitr::knit_code$get("as_interactive"),
+  knitr::knit_code$get("setup"),
   knitr::knit_code$get("module_4"),
   knitr::knit_code$get("app_4")
 ), collapse = "\n")
@@ -318,9 +322,6 @@ This allows `ReporterCard` to store the code necessary to generate the table alo
 To learn more about `teal.code` see the vignette _`qenv`_ in  `teal.code`.
 
 ```{r app_5}
-library(teal)
-library(teal.reporter)
-
 example_reporter_module <- function(label = "Example") {
   module(
     label = label,
@@ -420,7 +421,7 @@ app <- init(
   ),
   filter = teal_slices(teal_slice(dataname = "AIR", varname = "Temp", selected = c(72, 85)))
 ) |>
-  modify_header("Example teal app with reporter")
+  modify_header(tags$h2("Example teal app with reporter"))
 
 if (interactive()) {
   shinyApp(app$ui, app$server)
@@ -430,6 +431,7 @@ if (interactive()) {
 ```{r shinylive_iframe_5, echo = FALSE, out.width = '150%', out.extra = 'style = "position: relative; z-index:1"', eval = requireNamespace("roxy.shinylive", quietly = TRUE) && knitr::is_html_output() && identical(Sys.getenv("IN_PKGDOWN"), "true")}
 code <- paste0(c(
   knitr::knit_code$get("as_interactive"),
+  knitr::knit_code$get("module_1"),
   knitr::knit_code$get("module_5"),
   knitr::knit_code$get("app_5")
 ), collapse = "\n")