updating document

R/tm_data_table.R

@@ -1,6 +1,7 @@
 #' Data Table Viewer Teal Module
 #'
 #' A data table viewer shows the data using a paginated table.
+#' specifically designed for use with `data.frames`.
 #' @md
 #'
 #' @inheritParams teal::module
@@ -12,6 +13,8 @@
 #' @param datasets_selected (`character`) A vector of datasets which should be
 #'   shown and in what order. Names in the vector have to correspond with datasets names.
 #'   If vector of length zero (default) then all datasets are shown.
+#'   Note: Only datasets of the `data.frame` class are compatible;
+#'   using other types will cause an error.
 #' @param dt_args (named `list`) Additional arguments to be passed to `DT::datatable`
 #'   (must not include `data` or `options`).
 #' @param dt_options (named `list`) The `options` argument to `DT::datatable`. By default

R/tm_missing_data.R

@@ -1,6 +1,7 @@
 #' Missing data module
 #'
 #' Present analysis of missing observations and patients.
+#' specifically designed for use with `data.frames`.
 #'
 #' @inheritParams teal::module
 #' @inheritParams shared_params

R/tm_variable_browser.R

@@ -2,6 +2,7 @@
 #'
 #' The variable browser provides a table with variable names and labels and a
 #' plot that visualizes the content of a particular variable.
+#' specifically designed for use with `data.frames`.
 #'
 #' @details Numeric columns with fewer than 30 distinct values can be treated as either factors
 #' or numbers with a checkbox allowing users to switch how they are treated (if < 6 unique values
@@ -17,6 +18,7 @@
 #' @param datasets_selected (`character`) A vector of datasets which should be
 #'   shown and in what order. Names in the vector have to correspond with datasets names.
 #'   If vector of length zero (default) then all datasets are shown.
+#'   Note: Only datasets of the `data.frame` class are compatible; using other types will cause an error.
 #'
 #' @aliases
 #'   tm_variable_browser_ui,
@@ -191,7 +193,8 @@ srv_variable_browser <- function(id,
 
     checkmate::assert_character(datasets_selected)
     checkmate::assert_subset(datasets_selected, datanames)
-    if (length(datasets_selected) != 0L) {
+    if (!identical(datasets_selected, character(0))) {
+      checkmate::assert_subset(datasets_selected, datanames)
       datanames <- datasets_selected
     }