Skip to content

Commit

Permalink
dot prefix in module and in vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
gogonzo committed Dec 19, 2024
1 parent df437d2 commit 38b9207
Show file tree
Hide file tree
Showing 3 changed files with 6 additions and 3 deletions.
4 changes: 3 additions & 1 deletion R/modules.R
Original file line number Diff line number Diff line change
Expand Up @@ -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.
#'
Expand All @@ -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
Expand Down
2 changes: 2 additions & 0 deletions man/teal_modules.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

3 changes: 1 addition & 2 deletions vignettes/including-data-in-teal-applications.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand Down

0 comments on commit 38b9207

Please sign in to comment.