diff --git a/R/modules.R b/R/modules.R index 221cb03d6..d1b171997 100644 --- a/R/modules.R +++ b/R/modules.R @@ -21,6 +21,7 @@ setOldClass("teal_modules") #' and the report previewer module [reporter_previewer_module()], respectively. #' #' # Restricting datasets used by `teal_module`: +#' #' 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. #' @@ -29,7 +30,8 @@ setOldClass("teal_modules") #' - Proxy variables for column modifications #' - Temporary datasets used to create final versions #' - Connection objects -#' +#' Datasets which name is prefixed in `teal_data` by the dot (`.`) are not displayed in the `teal` application. +#' 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 diff --git a/man/teal_modules.Rd b/man/teal_modules.Rd index e3ef8361b..a86cc1539 100644 --- a/man/teal_modules.Rd +++ b/man/teal_modules.Rd @@ -141,6 +141,8 @@ However, this may include unnecessary datasets, such as: \item Proxy variables for column modifications \item Temporary datasets used to create final versions \item Connection objects +Datasets which name is prefixed in \code{teal_data} by the dot (\code{.}) are not displayed in the \code{teal} application. +Please see the \emph{"Hidden datasets"} section in `vignette("including-data-in-teal-applications"). } } diff --git a/vignettes/including-data-in-teal-applications.Rmd b/vignettes/including-data-in-teal-applications.Rmd index 6961ae59e..fb75c39c1 100644 --- a/vignettes/including-data-in-teal-applications.Rmd +++ b/vignettes/including-data-in-teal-applications.Rmd @@ -235,8 +235,7 @@ For a detailed explanation of verification, see [this `teal.data` vignette](http ##### Hidden datasets -An object is hidden in `teal_data` if its name starts with a dot (`.`). This can be used to pass auxiliary objects in -the `teal_data` instance, without being visible in the `teal` summary and filter panel. +An object is hidden in `teal_data` and `teal` application if its name starts with a dot (`.`). This can be used to pass auxiliary objects in the `teal_data` instance, without being visible in the `teal` summary and filter panel. ```{r} my_data <- teal_data()