diff --git a/R/dummy_functions.R b/R/dummy_functions.R index b04c4a488b..ed0a582c02 100644 --- a/R/dummy_functions.R +++ b/R/dummy_functions.R @@ -9,8 +9,8 @@ #' to read more about decorators. #' #' @inheritParams teal_modules -#' @param decorators `r lifecycle::badge("experimental")` (`list` of `teal_transform_module` or `NULL`) optional, -#' if not `NULL`, decorator for tables or plots included in the module. +#' @param decorators `r lifecycle::badge("experimental")` (`list` of `teal_transform_module`) optional, +#' decorator for `object` included in the module. #' #' @return A `teal` module which can be included in the `modules` argument to [init()]. #' @examples @@ -25,9 +25,9 @@ example_module <- function(label = "example teal module", datanames = "all", transformators = list(), - decorators = NULL) { + decorators = list()) { checkmate::assert_string(label) - checkmate::assert_list(decorators, "teal_transform_module", null.ok = TRUE) + checkmate::assert_list(decorators, "teal_transform_module") ans <- module( label, diff --git a/man/example_module.Rd b/man/example_module.Rd index 239ca105d5..cae924c932 100644 --- a/man/example_module.Rd +++ b/man/example_module.Rd @@ -8,7 +8,7 @@ example_module( label = "example teal module", datanames = "all", transformators = list(), - decorators = NULL + decorators = list() ) } \arguments{ @@ -27,8 +27,8 @@ argument. \item{transformators}{(\code{list} of \code{teal_transform_module}) that will be applied to transform module's data input. To learn more check \code{vignette("data-transform-as-shiny-module", package = "teal")}.} -\item{decorators}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} (\code{list} of \code{teal_transform_module} or \code{NULL}) optional, -if not \code{NULL}, decorator for tables or plots included in the module.} +\item{decorators}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} (\code{list} of \code{teal_transform_module}) optional, +decorator for \code{object} included in the module.} } \value{ A \code{teal} module which can be included in the \code{modules} argument to \code{\link[=init]{init()}}.