R/utils-roxygen.R

In connector: Streamlining Data Access in Clinical Research

#' Documentation for central components reused in several connectors and functions
#' this solution was chosen since roxygen does not support the use of @inheritParams and @inherits for R6 objects
#' @noRd
rd_connector_utils <- function(param) {
  x <- c(
    "name" = "[character] Name of the content to read, write, or remove. Typically the table name.",
    "x" = "The object to write to the connection",
    "file" = "[character] Path to the file to download to or upload from",
    "..." = "Additional arguments passed to the method for the individual connector.",
    "extra_class" = "[character] Extra class to assign to the new connector.",
    "connector_object" = "[Connector] The connector object to use.",
    "inv_self" = "[invisible] self.",
    "inv_connector" = "[invisible] connector_object.",
    "overwrite" = "[logical] Overwrite existing content if it exists.",
    "open" = "[logical] Open the directory as a new connector object."
  )
  x[[param]]
}