From ab96873708a7e61f7e6376e527d9727a6e0034d8 Mon Sep 17 00:00:00 2001 From: Dawid Kaledkowski Date: Mon, 20 Jan 2025 12:24:54 +0100 Subject: [PATCH] rephrase --- R/modules.R | 4 ++-- man/teal_modules.Rd | 4 ++-- 2 files changed, 4 insertions(+), 4 deletions(-) diff --git a/R/modules.R b/R/modules.R index 45af2de06..b314e8ccd 100644 --- a/R/modules.R +++ b/R/modules.R @@ -49,8 +49,8 @@ setOldClass("teal_modules") #' - `input`, `output`, `session` - (optional; not recommended) When provided, then [shiny::callModule()] #' will be used to call a module. From `shiny` 1.5.0, the recommended way is to use #' [shiny::moduleServer()] instead which doesn't require these arguments. -#' - `data` (optional) When provided, the module will be called with `teal_data` object (i.e. a list of -#' reactive (filtered) data specified in the `filters` argument) as the value of this argument. +#' - `data` (optional) If the server function includes a `data` argument, it will receive a reactive +#' expression containing the `teal_data` object. #' - `datasets` (optional) When provided, the module will be called with `FilteredData` object as the #' value of this argument. (See [`teal.slice::FilteredData`]). #' - `reporter` (optional) When provided, the module will be called with `Reporter` object as the value diff --git a/man/teal_modules.Rd b/man/teal_modules.Rd index 3b506e705..ee259cb2f 100644 --- a/man/teal_modules.Rd +++ b/man/teal_modules.Rd @@ -50,8 +50,8 @@ For \code{modules()} defaults to \code{"root"}. See \code{Details}.} \item \code{input}, \code{output}, \code{session} - (optional; not recommended) When provided, then \code{\link[shiny:callModule]{shiny::callModule()}} will be used to call a module. From \code{shiny} 1.5.0, the recommended way is to use \code{\link[shiny:moduleServer]{shiny::moduleServer()}} instead which doesn't require these arguments. -\item \code{data} (optional) When provided, the module will be called with \code{teal_data} object (i.e. a list of -reactive (filtered) data specified in the \code{filters} argument) as the value of this argument. +\item \code{data} (optional) If the server function includes a \code{data} argument, it will receive a reactive +expression containing the \code{teal_data} object. \item \code{datasets} (optional) When provided, the module will be called with \code{FilteredData} object as the value of this argument. (See \code{\link[teal.slice:FilteredData]{teal.slice::FilteredData}}). \item \code{reporter} (optional) When provided, the module will be called with \code{Reporter} object as the value