From f769f564493f048f747fdf8ea4df60d07be05a8b Mon Sep 17 00:00:00 2001 From: m7pr Date: Wed, 7 Feb 2024 11:51:45 +0100 Subject: [PATCH] extend description of ... in get_code --- R/teal_data-get_code.R | 4 +++- man/get_code.Rd | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/R/teal_data-get_code.R b/R/teal_data-get_code.R index 19e343c75..64443fa6a 100644 --- 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 index c0304b828..a72c7b0c8 100644 --- a/man/get_code.Rd +++ b/man/get_code.Rd @@ -15,7 +15,9 @@ \item{datanames}{\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#experimental}{\figure{lifecycle-experimental.svg}{options: alt='[Experimental]'}}}{\strong{[Experimental]}} (\code{character}) vector of dataset names to return the code for. For more details see the "Extracting dataset-specific code" section.} -\item{...}{Parameters passed to other methods.} +\item{...}{Parameters passed to internal methods. Currently, the only supported parameter is \code{check_names} +(\code{logical(1)}) flag, which is \code{TRUE} by default. Function warns about missing objects, if they do not exist in +\code{code} but are passed in \code{datanames}. To remove the warning, set \code{check_names = FALSE}.} } \value{ Either a character string or an expression. If \code{datanames} is used to request a specific dataset,