deprecate id from init (#1442)

- deprecate id in init #1438  
- fixing (wrong) id documentation in inherited docs. Please notice that
methods were inheriting `id` documentation from init. It means that all
modules had a wrong description.

NEWS.md

@@ -3,6 +3,7 @@
 ### New features
 
 * Possible to call `ui_teal` and `srv_teal` directly in any application by delivering `data` argument as a `reactive` returning `teal_data` object. #669
+* Since introduction of `ui_teal` and `srv_teal` functions `id` argument in `init` is being deprecated. #1438
 * Introduced `teal_transform_module` to provide a way to interactively modify data delivered to `teal_module`'s `server` and to decorate module outputs. #1228 #1384
 * Introduced a new argument `once = FALSE` in `teal_data_module` to possibly reload data during a run time.
 * Possibility to download lockfile to restore app session for reproducibility. #479

R/init.R

@@ -27,9 +27,11 @@
 #'   the header of the app.
 #' @param footer (`shiny.tag` or `character(1)`) Optionally,
 #'   the footer of the app.
-#' @param id (`character`) Optionally,
+#' @param id `r lifecycle::badge("deprecated")` (`character`) Optionally,
 #'   a string specifying the `shiny` module id in cases it is used as a `shiny` module
-#'   rather than a standalone `shiny` app. This is a legacy feature.
+#'   rather than a standalone `shiny` app. This is a legacy feature. Deprecated since v0.15.3
+#'   please use [ui_teal()] and [srv_teal()] instead.
+#'
 #' @param landing_popup (`teal_module_landing`) Optionally,
 #'   a `landing_popup_module` to show up as soon as the teal app is initialized.
 #'
@@ -96,7 +98,7 @@ init <- function(data,
                  title = build_app_title(),
                  header = tags$p(),
                  footer = tags$p(),
-                 id = character(0),
+                 id = lifecycle::deprecated(),
                  landing_popup = NULL) {
   logger::log_debug("init initializing teal app with: data ('{ class(data) }').")
 
@@ -137,7 +139,6 @@ init <- function(data,
     checkmate::check_string(footer),
     checkmate::check_multi_class(footer, c("shiny.tag", "shiny.tag.list", "html"))
   )
-  checkmate::assert_character(id, max.len = 1, any.missing = FALSE)
 
   # log
   teal.logger::log_system_info()
@@ -221,6 +222,20 @@ init <- function(data,
     )
   }
 
+
+  if (lifecycle::is_present(id)) {
+    lifecycle::deprecate_soft(
+      when = "0.15.3",
+      what = "init(id)",
+      details = paste(
+        "To wrap `teal` application within other shiny application please use",
+        "`ui_teal()` and `srv_teal()` and call them as regular shiny modules."
+      )
+    )
+    checkmate::assert_character(id, max.len = 1, any.missing = FALSE)
+  } else {
+    id <- character(0)
+  }
   ns <- NS(id)
   # Note: UI must be a function to support bookmarking.
   res <- list(

R/module_bookmark_manager.R

@@ -29,7 +29,7 @@
 #' - set `options(shiny.bookmarkStore = "server")` before running the app
 #'
 #'
-#' @inheritParams init
+#' @inheritParams module_teal
 #'
 #' @return Invisible `NULL`.
 #'

R/module_data_summary.R

@@ -12,8 +12,7 @@
 #' Module includes also "Show/Hide unsupported" button to toggle rows of the summary table
 #' containing datasets where number of observations are not calculated.
 #'
-#' @param id (`character(1)`) `shiny` module instance id.
-#' @param teal_data (`reactive` returning `teal_data`)
+#' @inheritParams module_teal_module
 #'
 #' @name module_data_summary
 #' @rdname module_data_summary

R/module_init_data.R

@@ -22,10 +22,7 @@
 #'
 #' For more details, see [`module_teal_data`].
 #'
-#' @inheritParams init
-#'
-#' @param data (`teal_data`, `teal_data_module`, or `reactive` returning `teal_data`)
-#' The data which application will depend on.
+#' @inheritParams module_teal
 #'
 #' @return A `reactive` object that returns:
 #' Output of the `data`. If `data` fails then returned error is handled (after [tryCatch()]) so that

R/module_teal.R

@@ -32,8 +32,10 @@
 #' @rdname module_teal
 #' @name module_teal
 #'
-#' @inheritParams module_init_data
 #' @inheritParams init
+#' @param id (`character(1)`) `shiny` module instance id.
+#' @param data (`teal_data`, `teal_data_module`, or `reactive` returning `teal_data`)
+#' The data which application will depend on.
 #'
 #' @return `NULL` invisibly
 NULL

R/module_teal_data.R

@@ -20,8 +20,7 @@
 #' resolved, the app will continue to run. `teal` guarantees that errors in data don't crash the app
 #' (except error 1).
 #'
-#' @param id (`character(1)`) Module id
-#' @param data (`reactive teal_data`)
+#' @inheritParams module_teal_module
 #' @param data_module (`teal_data_module`)
 #' @param modules (`teal_modules` or `teal_module`) For `datanames` validation purpose
 #' @param validate_shiny_silent_error (`logical`) If `TRUE`, then `shiny.silent.error` is validated and

R/module_teal_lockfile.R

@@ -1,5 +1,6 @@
 #' Generate lockfile for application's environment reproducibility
 #'
+#' @inheritParams module_teal
 #' @param lockfile_path (`character`) path to the lockfile.
 #'
 #' @section Different ways of creating lockfile: