diff --git a/R/redcap-file-repo-list.R b/R/redcap-file-repo-list.R index af8f9b1d..0336ce88 100644 --- a/R/redcap-file-repo-list.R +++ b/R/redcap-file-repo-list.R @@ -31,6 +31,10 @@ #' #' @return #' Currently, a list is returned with the following elements, +#' * `data`: A [tibble::tibble] with the following columns: +#' `folder_id`, `doc_id`, and (file) `name`. +#' Each sub-folder will have an associated `folder_id` integer, +#' and each file will have an associated `doc_id` integer. #' * `success`: A boolean value indicating if the operation was apparently #' successful. #' * `status_code`: The @@ -39,21 +43,11 @@ #' * `outcome_message`: A human readable string indicating the operation's #' outcome. #' * `records_affected_count`: The number of records inserted or updated. -#' * `affected_ids`: The subject IDs of the inserted or updated records. #' * `elapsed_seconds`: The duration of the function. #' * `raw_text`: If an operation is NOT successful, the text returned by #' REDCap. If an operation is successful, the `raw_text` is returned as an #' empty string to save RAM. -#' * `file_name`: The name of the file persisted to disk. This is useful if -#' the name stored in REDCap is used (which is the default). #' -#' @details -#' For files in a repeating instrument, don't specify `repeating_instrument`. -#' The server only needs `field` (name) and `repeating_instance`. -#' -#' The function `redcap_download_file_oneshot()` is soft-deprecated -#' as of REDCapR 1.2.0. -#' Please rename to [redcap_file_download_oneshot()]. #' #' @author #' Will Beasley diff --git a/man/redcap_file_repo_list_oneshot.Rd b/man/redcap_file_repo_list_oneshot.Rd index 04730e60..9b68ee0f 100644 --- a/man/redcap_file_repo_list_oneshot.Rd +++ b/man/redcap_file_repo_list_oneshot.Rd @@ -43,6 +43,10 @@ should be \code{NULL} for most institutions. Optional.} \value{ Currently, a list is returned with the following elements, \itemize{ +\item \code{data}: A \link[tibble:tibble]{tibble::tibble} with the following columns: +\code{folder_id}, \code{doc_id}, and (file) \code{name}. +Each sub-folder will have an associated \code{folder_id} integer, +and each file will have an associated \code{doc_id} integer. \item \code{success}: A boolean value indicating if the operation was apparently successful. \item \code{status_code}: The @@ -51,13 +55,10 @@ of the operation. \item \code{outcome_message}: A human readable string indicating the operation's outcome. \item \code{records_affected_count}: The number of records inserted or updated. -\item \code{affected_ids}: The subject IDs of the inserted or updated records. \item \code{elapsed_seconds}: The duration of the function. \item \code{raw_text}: If an operation is NOT successful, the text returned by REDCap. If an operation is successful, the \code{raw_text} is returned as an empty string to save RAM. -\item \code{file_name}: The name of the file persisted to disk. This is useful if -the name stored in REDCap is used (which is the default). } } \description{ @@ -66,14 +67,6 @@ folder in a project's File Repository. Each sub-folder will have an associated folder_id number, and each file will have an associated doc_id number. } -\details{ -For files in a repeating instrument, don't specify \code{repeating_instrument}. -The server only needs \code{field} (name) and \code{repeating_instance}. - -The function \code{redcap_download_file_oneshot()} is soft-deprecated -as of REDCapR 1.2.0. -Please rename to \code{\link[=redcap_file_download_oneshot]{redcap_file_download_oneshot()}}. -} \examples{ \dontrun{ uri <- "https://redcap-dev-2.ouhsc.edu/redcap/api/"