diff --git a/R/kernel-api.R b/R/kernel-api.R index f44d644d..87fa3d7b 100644 --- a/R/kernel-api.R +++ b/R/kernel-api.R @@ -9,8 +9,8 @@ #' typically formatted as "https://server.org/apps/redcap/api/". #' Required. #' @param post_body List of contents expected by the REDCap API. Required. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' @param encoding The encoding value passed to [httr::content()]. Defaults #' to 'UTF-8'. #' @param content_type The MIME value passed to [httr::content()]. Defaults diff --git a/R/redcap-arm-export.R b/R/redcap-arm-export.R index d95284be..44d998bf 100644 --- a/R/redcap-arm-export.R +++ b/R/redcap-arm-export.R @@ -14,8 +14,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details in [redcap_read_oneshot()]. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `has_arms`: a `logical` value indicating if the REDCap project has diff --git a/R/redcap-dag-read.R b/R/redcap-dag-read.R index 2a3eec50..5b662981 100644 --- a/R/redcap-dag-read.R +++ b/R/redcap-dag-read.R @@ -14,13 +14,13 @@ #' [httr::content()]. Defaults to 'UTF-8'. #' @param locale a [readr::locale()] object to specify preferences like #' number, date, and time formats. This object is passed to -#' [`readr::read_csv()`]. Defaults to [readr::default_locale()]. +#' [readr::read_csv()]. Defaults to [readr::default_locale()]. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data`: A [tibble::tibble()] of all data access groups of the project. diff --git a/R/redcap-download-file-oneshot.R b/R/redcap-download-file-oneshot.R index 8ba0f57d..1e8dae79 100644 --- a/R/redcap-download-file-oneshot.R +++ b/R/redcap-download-file-oneshot.R @@ -30,8 +30,8 @@ #' Optional #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. Optional. -#' @param config_options A list of options to pass to [httr::POST()] method -#' in the 'httr' package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements, #' * `success`: A boolean value indicating if the operation was apparently diff --git a/R/redcap-event-instruments.R b/R/redcap-event-instruments.R index 15f90034..5d363ecc 100644 --- a/R/redcap-event-instruments.R +++ b/R/redcap-event-instruments.R @@ -18,8 +18,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements, #' * `data`: A [tibble::tibble()] where each row represents one column @@ -36,11 +36,6 @@ #' REDCap. If an operation is successful, the `raw_text` is returned as an #' empty string to save RAM. #' -#' @details -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` package and -#' documentation is available at https://cran.r-project.org/package=httr. -#' #' @author Victor Castro, Will Beasley #' #' @references The official documentation can be found on the 'API Help Page' diff --git a/R/redcap-instrument-download.R b/R/redcap-instrument-download.R index 20e9ffd3..04a12463 100644 --- a/R/redcap-instrument-download.R +++ b/R/redcap-instrument-download.R @@ -25,8 +25,8 @@ #' only for the specified event from that record. Optional. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. Optional. -#' @param config_options A list of options to pass to [httr::POST()] method -#' in the 'httr' package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements, #' * `success`: A boolean value indicating if the operation was apparently diff --git a/R/redcap-instruments.R b/R/redcap-instruments.R index 7e9db395..7b5d1ed8 100644 --- a/R/redcap-instruments.R +++ b/R/redcap-instruments.R @@ -20,8 +20,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements, #' * `data`: A [tibble::tibble()] where each row represents one column @@ -38,11 +38,6 @@ #' REDCap. If an operation is successful, the `raw_text` is returned as an #' empty string to save RAM. #' -#' @details -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` package and -#' documentation is available at https://cran.r-project.org/package=httr. -#' #' @author Victor Castro, Will Beasley #' #' @references The official documentation can be found on the 'API Help Page' diff --git a/R/redcap-log-read.R b/R/redcap-log-read.R index 68ccd10d..60de1831 100644 --- a/R/redcap-log-read.R +++ b/R/redcap-log-read.R @@ -30,13 +30,13 @@ #' [httr::content()]. Defaults to 'UTF-8'. #' @param locale a [readr::locale()] object to specify preferences like #' number, date, and time formats. This object is passed to -#' [`readr::read_csv()`]. Defaults to [readr::default_locale()]. +#' [readr::read_csv()]. Defaults to [readr::default_locale()]. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data`: An R [tibble::tibble()] of all data access groups of the project. diff --git a/R/redcap-metadata-coltypes.R b/R/redcap-metadata-coltypes.R index b3686c21..063da324 100644 --- a/R/redcap-metadata-coltypes.R +++ b/R/redcap-metadata-coltypes.R @@ -15,13 +15,13 @@ #' [httr::content()]. Defaults to 'UTF-8'. #' @param locale a [readr::locale()] object to specify preferences like #' number, date, and time formats. This object is passed to -#' [`readr::read_csv()`]. Defaults to [readr::default_locale()]. +#' [readr::read_csv()]. Defaults to [readr::default_locale()]. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return A [readr::cols()] object is returned, which can be #' passed to [redcap_read()] or [redcap_read_oneshot()]. @@ -102,10 +102,6 @@ #' then (c) in a [dplyr::mutate()] statement, #' use [readr::parse_integer()] to cast it to the desired type. #' -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` package and -#' documentation is available at https://cran.r-project.org/package=httr. -#' #' @author Will Beasley, Philip Chase #' #' @references The official documentation can be found on the 'API Help Page' diff --git a/R/redcap-metadata-read.R b/R/redcap-metadata-read.R index 29006ef2..9dcd0faf 100644 --- a/R/redcap-metadata-read.R +++ b/R/redcap-metadata-read.R @@ -23,8 +23,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details in [redcap_read_oneshot()]. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' diff --git a/R/redcap-metadata-write.R b/R/redcap-metadata-write.R index 6df5bff3..9f786c43 100644 --- a/R/redcap-metadata-write.R +++ b/R/redcap-metadata-write.R @@ -18,8 +18,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to [httr::POST()] method -#' in the 'httr' package. See the details in [redcap_read_oneshot()] Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `success`: A boolean value indicating if the operation was apparently diff --git a/R/redcap-next-free-record-name.R b/R/redcap-next-free-record-name.R index 093b2c80..ace2898a 100644 --- a/R/redcap-next-free-record-name.R +++ b/R/redcap-next-free-record-name.R @@ -13,8 +13,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return a [base::character] vector of either #' length 1 (if successful) or length 0 (if not successful). diff --git a/R/redcap-project-info-read.R b/R/redcap-project-info-read.R index 900bc698..89d79ae2 100644 --- a/R/redcap-project-info-read.R +++ b/R/redcap-project-info-read.R @@ -16,13 +16,13 @@ #' [httr::content()]. Defaults to 'UTF-8'. #' @param locale a [readr::locale()] object to specify preferences like #' number, date, and time formats. This object is passed to -#' [`readr::read_csv()`]. Defaults to [readr::default_locale()]. +#' [readr::read_csv()]. Defaults to [readr::default_locale()]. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data`: An R [tibble::tibble()] of all data access groups of the project. diff --git a/R/redcap-read-oneshot-eav.R b/R/redcap-read-oneshot-eav.R index 1282d701..c1718d17 100644 --- a/R/redcap-read-oneshot-eav.R +++ b/R/redcap-read-oneshot-eav.R @@ -66,8 +66,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data`: A [tibble::tibble()] of the desired records and columns. @@ -89,10 +89,6 @@ #' empty string to save RAM. #' #' @details -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` -#' package and documentation is available at -#' https://cran.r-project.org/package=httr. #' #' If you do not pass in this export_data_access_groups value, it will #' default to `FALSE`. The following is from the API help page for version diff --git a/R/redcap-read-oneshot.R b/R/redcap-read-oneshot.R index b2fe0bfd..18d3e022 100644 --- a/R/redcap-read-oneshot.R +++ b/R/redcap-read-oneshot.R @@ -77,13 +77,13 @@ #' [httr::content()]. Defaults to 'UTF-8'. #' @param locale a [readr::locale()] object to specify preferences like #' number, date, and time formats. This object is passed to -#' [`readr::read_csv()`]. Defaults to [readr::default_locale()]. +#' [readr::read_csv()]. Defaults to [readr::default_locale()]. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data`: A [tibble::tibble()] of the desired records and columns. @@ -105,11 +105,8 @@ #' empty string to save RAM. #' #' @details -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` package and -#' documentation is available at https://cran.r-project.org/package=httr. #' -#' If you do not pass in this `export_data_access_groups` value, it will default +#' If you do not pass an `export_data_access_groups` value, it will default #' to `FALSE`. The following is from the API help page for version 10.5.1: #' *This flag is only viable if the user whose token is being used to make the #' API request is **not** in a data access group. If the user is in a group, @@ -148,7 +145,6 @@ #' fields = desired_fields_v1 #' )$data #' -#' #' # Specify the column types. #' col_types <- readr::cols( #' record_id = readr::col_integer(), @@ -164,7 +160,6 @@ #' token = token, #' col_types = col_types #' )$data -#' #' } #' @importFrom magrittr %>% diff --git a/R/redcap-read.R b/R/redcap-read.R index 55ba28af..bee2bd71 100644 --- a/R/redcap-read.R +++ b/R/redcap-read.R @@ -88,13 +88,13 @@ #' [httr::content()]. Defaults to 'UTF-8'. #' @param locale a [readr::locale()] object to specify preferences like #' number, date, and time formats. This object is passed to -#' [`readr::read_csv()`]. Defaults to [readr::default_locale()]. +#' [readr::read_csv()]. Defaults to [readr::default_locale()]. #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details in `redcap_read_oneshot()` Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' @param id_position The column position of the variable that unique #' identifies the subject (typically `record_id`). #' This defaults to the first variable in the dataset. diff --git a/R/redcap-report.R b/R/redcap-report.R index 9c130f20..a62f7a53 100644 --- a/R/redcap-report.R +++ b/R/redcap-report.R @@ -35,8 +35,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data`: A [tibble::tibble()] of the desired records and columns. @@ -52,11 +52,6 @@ #' REDCap. If an operation is successful, the `raw_text` is returned as an #' empty string to save RAM. #' -#' @details -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` package and -#' documentation is available at https://cran.r-project.org/package=httr. -#' #' @author Will Beasley #' #' @references The official documentation can be found on the 'API Help Page' diff --git a/R/redcap-survey-link-export-oneshot.R b/R/redcap-survey-link-export-oneshot.R index 29a0b374..4b70362d 100644 --- a/R/redcap-survey-link-export-oneshot.R +++ b/R/redcap-survey-link-export-oneshot.R @@ -16,8 +16,8 @@ #' Optional #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. Optional. -#' @param config_options A list of options to pass to [httr::POST()] method -#' in the 'httr' package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements, #' * `success`: A boolean value indicating if the operation was apparently diff --git a/R/redcap-upload-file-oneshot.R b/R/redcap-upload-file-oneshot.R index b761510f..214af1d5 100644 --- a/R/redcap-upload-file-oneshot.R +++ b/R/redcap-upload-file-oneshot.R @@ -18,8 +18,8 @@ #' Optional #' @param verbose A boolean value indicating if `message`s should be printed #' to the R console during the operation. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `success`: A boolean value indicating if the operation was apparently diff --git a/R/redcap-users-export.R b/R/redcap-users-export.R index 264ba762..8fa9a8e9 100644 --- a/R/redcap-users-export.R +++ b/R/redcap-users-export.R @@ -13,8 +13,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `data_user`: A [tibble::tibble()] of all users associated with the project. diff --git a/R/redcap-variables.R b/R/redcap-variables.R index 3d5dde7e..33a37331 100644 --- a/R/redcap-variables.R +++ b/R/redcap-variables.R @@ -14,8 +14,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements, #' * `data`: A [tibble::tibble()] where each row represents one column @@ -33,9 +33,6 @@ #' empty string to save RAM. #' #' @details -#' The full list of configuration options accepted by the `httr` package is -#' viewable by executing [httr::httr_options()]. The `httr` package and -#' documentation is available at https://cran.r-project.org/package=httr. #' #' As of REDCap version 6.14.2, three variable types are *not* returned in #' this call: calculated, file, and descriptive. All variables returned are diff --git a/R/redcap-version.R b/R/redcap-version.R index 9a622532..1da84520 100644 --- a/R/redcap-version.R +++ b/R/redcap-version.R @@ -13,8 +13,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details below. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return a [utils::packageDescription] #' diff --git a/R/redcap-write-oneshot.R b/R/redcap-write-oneshot.R index b7cc7da1..24c2f18d 100644 --- a/R/redcap-write-oneshot.R +++ b/R/redcap-write-oneshot.R @@ -26,8 +26,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to [httr::POST()] method -#' in the 'httr' package. See the details in [redcap_read_oneshot()] Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `success`: A boolean value indicating if the operation was apparently diff --git a/R/redcap-write.R b/R/redcap-write.R index 9ca99a18..7d43b2c1 100644 --- a/R/redcap-write.R +++ b/R/redcap-write.R @@ -33,8 +33,8 @@ #' to the R console during the operation. The verbose output might contain #' sensitive information (*e.g.* PHI), so turn this off if the output might #' be visible somewhere public. Optional. -#' @param config_options A list of options to pass to `POST` method in the -#' `httr` package. See the details in [redcap_read_oneshot()]. Optional. +#' @param config_options A list of options passed to [httr::POST()]. +#' See details at [httr::httr_options()]. Optional. #' #' @return Currently, a list is returned with the following elements: #' * `success`: A boolean value indicating if the operation was apparently diff --git a/man/kernel_api.Rd b/man/kernel_api.Rd index 1a365bd5..f973999b 100644 --- a/man/kernel_api.Rd +++ b/man/kernel_api.Rd @@ -21,8 +21,8 @@ Required.} \item{post_body}{List of contents expected by the REDCap API. Required.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} \item{encoding}{The encoding value passed to \code{\link[httr:content]{httr::content()}}. Defaults to 'UTF-8'.} diff --git a/man/redcap_arm_export.Rd b/man/redcap_arm_export.Rd index e74723d3..2daa6e1b 100644 --- a/man/redcap_arm_export.Rd +++ b/man/redcap_arm_export.Rd @@ -21,8 +21,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details in \code{\link[=redcap_read_oneshot]{redcap_read_oneshot()}}. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_dag_read.Rd b/man/redcap_dag_read.Rd index 01aaefe9..f9eb133f 100644 --- a/man/redcap_dag_read.Rd +++ b/man/redcap_dag_read.Rd @@ -35,8 +35,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_delete.Rd b/man/redcap_delete.Rd index f74b3afb..debb9c65 100644 --- a/man/redcap_delete.Rd +++ b/man/redcap_delete.Rd @@ -36,8 +36,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details in \code{\link[=redcap_read_oneshot]{redcap_read_oneshot()}}. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_download_file_oneshot.Rd b/man/redcap_download_file_oneshot.Rd index 33901789..02cff709 100644 --- a/man/redcap_download_file_oneshot.Rd +++ b/man/redcap_download_file_oneshot.Rd @@ -59,8 +59,8 @@ Optional} \item{verbose}{A boolean value indicating if \code{message}s should be printed to the R console during the operation. Optional.} -\item{config_options}{A list of options to pass to \code{\link[httr:POST]{httr::POST()}} method -in the 'httr' package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements, diff --git a/man/redcap_download_instrument.Rd b/man/redcap_download_instrument.Rd index 4a3f2245..49b46c7d 100644 --- a/man/redcap_download_instrument.Rd +++ b/man/redcap_download_instrument.Rd @@ -50,8 +50,8 @@ only for the specified event from that record. Optional.} \item{verbose}{A boolean value indicating if \code{message}s should be printed to the R console during the operation. Optional.} -\item{config_options}{A list of options to pass to \code{\link[httr:POST]{httr::POST()}} method -in the 'httr' package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements, diff --git a/man/redcap_event_instruments.Rd b/man/redcap_event_instruments.Rd index bc4fb304..215f66f6 100644 --- a/man/redcap_event_instruments.Rd +++ b/man/redcap_event_instruments.Rd @@ -29,8 +29,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements, @@ -57,11 +57,6 @@ events in a longitudinal project). (Copied from "Export Instrument-Event Mappings" method of REDCap API documentation, v.10.5.1) } -\details{ -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} package and -documentation is available at https://cran.r-project.org/package=httr. -} \examples{ \dontrun{ uri <- "https://bbmc.ouhsc.edu/redcap/api/" diff --git a/man/redcap_instruments.Rd b/man/redcap_instruments.Rd index 09e28f56..91e9a9e2 100644 --- a/man/redcap_instruments.Rd +++ b/man/redcap_instruments.Rd @@ -21,8 +21,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements, @@ -52,11 +52,6 @@ their order in the project. (Copied from "Export Instruments (Data Entry Forms)" method of REDCap API documentation, v.10.5.1) } -\details{ -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} package and -documentation is available at https://cran.r-project.org/package=httr. -} \examples{ \dontrun{ uri <- "https://bbmc.ouhsc.edu/redcap/api/" diff --git a/man/redcap_log_read.Rd b/man/redcap_log_read.Rd index 95ee72e9..af4caf18 100644 --- a/man/redcap_log_read.Rd +++ b/man/redcap_log_read.Rd @@ -59,8 +59,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_metadata_coltypes.Rd b/man/redcap_metadata_coltypes.Rd index 3fca6b3c..f45f1328 100644 --- a/man/redcap_metadata_coltypes.Rd +++ b/man/redcap_metadata_coltypes.Rd @@ -35,8 +35,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ A \code{\link[readr:cols]{readr::cols()}} object is returned, which can be @@ -120,10 +120,6 @@ returned by the API. The the "abcd" scenario, consider (a) changing the type from \code{col_integer} to \code{col_character}, (b) excluding the trash values, then (c) in a \code{\link[dplyr:mutate]{dplyr::mutate()}} statement, use \code{\link[readr:parse_atomic]{readr::parse_integer()}} to cast it to the desired type. - -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} package and -documentation is available at https://cran.r-project.org/package=httr. } \examples{ \dontrun{ diff --git a/man/redcap_metadata_read.Rd b/man/redcap_metadata_read.Rd index 31f9eb22..00629424 100644 --- a/man/redcap_metadata_read.Rd +++ b/man/redcap_metadata_read.Rd @@ -42,8 +42,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details in \code{\link[=redcap_read_oneshot]{redcap_read_oneshot()}}. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_metadata_write.Rd b/man/redcap_metadata_write.Rd index f991813a..e5c9ec0f 100644 --- a/man/redcap_metadata_write.Rd +++ b/man/redcap_metadata_write.Rd @@ -30,8 +30,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{\link[httr:POST]{httr::POST()}} method -in the 'httr' package. See the details in \code{\link[=redcap_read_oneshot]{redcap_read_oneshot()}} Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_next_free_record_name.Rd b/man/redcap_next_free_record_name.Rd index 4c12c159..94f77411 100644 --- a/man/redcap_next_free_record_name.Rd +++ b/man/redcap_next_free_record_name.Rd @@ -26,8 +26,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ a \link[base:character]{base::character} vector of either diff --git a/man/redcap_project_info_read.Rd b/man/redcap_project_info_read.Rd index a3af0304..f1f08428 100644 --- a/man/redcap_project_info_read.Rd +++ b/man/redcap_project_info_read.Rd @@ -35,8 +35,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_read.Rd b/man/redcap_read.Rd index 8d4edcfd..b29a65d6 100644 --- a/man/redcap_read.Rd +++ b/man/redcap_read.Rd @@ -150,8 +150,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details in \code{redcap_read_oneshot()} Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} \item{id_position}{The column position of the variable that unique identifies the subject (typically \code{record_id}). diff --git a/man/redcap_read_oneshot.Rd b/man/redcap_read_oneshot.Rd index a3d02f6b..03e2288c 100644 --- a/man/redcap_read_oneshot.Rd +++ b/man/redcap_read_oneshot.Rd @@ -137,8 +137,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: @@ -166,11 +166,7 @@ empty string to save RAM. This function uses REDCap's API to select and return data. } \details{ -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} package and -documentation is available at https://cran.r-project.org/package=httr. - -If you do not pass in this \code{export_data_access_groups} value, it will default +If you do not pass an \code{export_data_access_groups} value, it will default to \code{FALSE}. The following is from the API help page for version 10.5.1: \emph{This flag is only viable if the user whose token is being used to make the API request is \strong{not} in a data access group. If the user is in a group, @@ -200,7 +196,6 @@ ds_some_fields_v1 <- REDCapR::redcap_read_oneshot( fields = desired_fields_v1 )$data - # Specify the column types. col_types <- readr::cols( record_id = readr::col_integer(), @@ -216,7 +211,6 @@ ds_col_types <- REDCapR::redcap_read_oneshot( token = token, col_types = col_types )$data - } } \references{ diff --git a/man/redcap_read_oneshot_eav.Rd b/man/redcap_read_oneshot_eav.Rd index 3d681586..9a1170cd 100644 --- a/man/redcap_read_oneshot_eav.Rd +++ b/man/redcap_read_oneshot_eav.Rd @@ -104,8 +104,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: @@ -134,11 +134,6 @@ This function uses REDCap's API to select and return data. This function is still in development. } \details{ -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} -package and documentation is available at -https://cran.r-project.org/package=httr. - If you do not pass in this export_data_access_groups value, it will default to \code{FALSE}. The following is from the API help page for version 5.2.3: diff --git a/man/redcap_report.Rd b/man/redcap_report.Rd index a36bb9c6..90be327b 100644 --- a/man/redcap_report.Rd +++ b/man/redcap_report.Rd @@ -60,8 +60,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: @@ -84,11 +84,6 @@ empty string to save RAM. Exports the data set of a report created on a project's 'Data Exports, Reports, and Stats' page. } -\details{ -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} package and -documentation is available at https://cran.r-project.org/package=httr. -} \examples{ \dontrun{ uri <- "https://bbmc.ouhsc.edu/redcap/api/" diff --git a/man/redcap_survey_link_export_oneshot.Rd b/man/redcap_survey_link_export_oneshot.Rd index 3b0e1449..91a5dd36 100644 --- a/man/redcap_survey_link_export_oneshot.Rd +++ b/man/redcap_survey_link_export_oneshot.Rd @@ -35,8 +35,8 @@ Optional} \item{verbose}{A boolean value indicating if \code{message}s should be printed to the R console during the operation. Optional.} -\item{config_options}{A list of options to pass to \code{\link[httr:POST]{httr::POST()}} method -in the 'httr' package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements, diff --git a/man/redcap_upload_file_oneshot.Rd b/man/redcap_upload_file_oneshot.Rd index b2626ffe..cbf02312 100644 --- a/man/redcap_upload_file_oneshot.Rd +++ b/man/redcap_upload_file_oneshot.Rd @@ -39,8 +39,8 @@ Optional} \item{verbose}{A boolean value indicating if \code{message}s should be printed to the R console during the operation. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_users_export.Rd b/man/redcap_users_export.Rd index 5f003ad0..f4b5b48f 100644 --- a/man/redcap_users_export.Rd +++ b/man/redcap_users_export.Rd @@ -21,8 +21,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_variables.Rd b/man/redcap_variables.Rd index c67613f7..5ad57eef 100644 --- a/man/redcap_variables.Rd +++ b/man/redcap_variables.Rd @@ -21,8 +21,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements, @@ -47,10 +47,6 @@ This function calls the 'exportFieldNames' function of the REDCap API. } \details{ -The full list of configuration options accepted by the \code{httr} package is -viewable by executing \code{\link[httr:httr_options]{httr::httr_options()}}. The \code{httr} package and -documentation is available at https://cran.r-project.org/package=httr. - As of REDCap version 6.14.2, three variable types are \emph{not} returned in this call: calculated, file, and descriptive. All variables returned are writable/uploadable. diff --git a/man/redcap_version.Rd b/man/redcap_version.Rd index 56189c72..71db5c2b 100644 --- a/man/redcap_version.Rd +++ b/man/redcap_version.Rd @@ -21,8 +21,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details below. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ a \link[utils:packageDescription]{utils::packageDescription} diff --git a/man/redcap_write.Rd b/man/redcap_write.Rd index 0b35d87b..10a5be11 100644 --- a/man/redcap_write.Rd +++ b/man/redcap_write.Rd @@ -58,8 +58,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{POST} method in the -\code{httr} package. See the details in \code{\link[=redcap_read_oneshot]{redcap_read_oneshot()}}. Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: diff --git a/man/redcap_write_oneshot.Rd b/man/redcap_write_oneshot.Rd index 7498a797..eaa7300f 100644 --- a/man/redcap_write_oneshot.Rd +++ b/man/redcap_write_oneshot.Rd @@ -45,8 +45,8 @@ to the R console during the operation. The verbose output might contain sensitive information (\emph{e.g.} PHI), so turn this off if the output might be visible somewhere public. Optional.} -\item{config_options}{A list of options to pass to \code{\link[httr:POST]{httr::POST()}} method -in the 'httr' package. See the details in \code{\link[=redcap_read_oneshot]{redcap_read_oneshot()}} Optional.} +\item{config_options}{A list of options passed to \code{\link[httr:POST]{httr::POST()}}. +See details at \code{\link[httr:httr_options]{httr::httr_options()}}. Optional.} } \value{ Currently, a list is returned with the following elements: