@kartikayakirar

R/utils.R

@@ -141,6 +141,16 @@ resolve_modules_datanames <- function(modules, datanames, join_keys) {
   }
 }
 
+#' Check `datanames` in modules
+#'
+#' This function ensures specified `datanames` in modules match those in the data object,
+#' returning error messages or `TRUE` for successful validation.
+#'
+#' @param modules (`teal_modules`) object
+#' @param datanames (`character`) names of datasets available in the `data` object
+#'
+#' @return A `character(1)` containing error message or `TRUE` if validation passes.
+#' @keywords internal
 check_modules_datanames <- function(modules, datanames) {
   recursive_check_datanames <- function(modules, datanames) {
     # check teal_modules against datanames
@@ -166,7 +176,16 @@ check_modules_datanames <- function(modules, datanames) {
   }
 }
 
-
+#' Check `datanames` in filters
+#'
+#' This function check `datanames` in filters correspond to those in `data`,
+#' returning character vector with error messages or TRUE if all checks pass.
+#'
+#' @param filters (`teal_slices`) object
+#' @param datanames (`character`) names of datasets available in the `data` object
+#'
+#' @return A `character(1)` containing error message or TRUE if validation passes.
+#' @keywords internal
 check_filter_datanames <- function(filters, datanames) {
   # check teal_slices against datanames
   out <- sapply(