extend description of ... in get_code

insightsengineering · Feb 7, 2024 · f769f56 · f769f56
1 parent dbe0391
commit f769f56
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 2 deletions.
diff --git a/R/teal_data-get_code.R b/R/teal_data-get_code.R
@@ -77,7 +77,9 @@
 #' For more details see the "Extracting dataset-specific code" section.
 #' @param deparse (`logical`) flag specifying whether to return code as `character` (`deparse = TRUE`) or as
 #' `expression` (`deparse = FALSE`).
-#' @param ... Parameters passed to other methods.
+#' @param ... Parameters passed to internal methods. Currently, the only supported parameter is `check_names`
+#' (`logical(1)`) flag,  which is `TRUE` by default. Function warns about missing objects, if they do not exist in
+#' `code` but are passed in `datanames`. To remove the warning, set `check_names = FALSE`.
 #'
 #' @return
 #' Either a character string or an expression. If `datanames` is used to request a specific dataset,

diff --git a/man/get_code.Rd b/man/get_code.Rd