Skip to content

Commit

Permalink
sections for redcap_read() doc
Browse files Browse the repository at this point in the history
ref #493
  • Loading branch information
wibeasley committed Jul 9, 2023
1 parent ce4f4df commit 784fded
Show file tree
Hide file tree
Showing 2 changed files with 18 additions and 2 deletions.
7 changes: 6 additions & 1 deletion R/redcap-read.R
Original file line number Diff line number Diff line change
Expand Up @@ -118,7 +118,8 @@
#' a zero-row tibble is returned.
#' Currently the empty tibble has zero columns, but that may change in the future.
#'
#' @details
#' @section Batching subsets of data:
#'
#' [redcap_read()] internally uses multiple calls to [redcap_read_oneshot()]
#' to select and return data. Initially, only the primary key is queried
#' through the REDCap API. The long list is then subsetted into batches,
Expand Down Expand Up @@ -148,6 +149,8 @@
#' 1. `redcap_repeat_instrument` and `redcap_repeat_instance` will be returned
#' for projects with repeating instruments
#'
#' @section Export permissions:
#'
#' For [redcap_read_oneshot()] to function properly, the user must have Export
#' permissions for the 'Full Data Set'. Users with only 'De-Identified'
#' export privileges can still use `redcap_read_oneshot`. To grant the
Expand All @@ -156,6 +159,8 @@
#' * select the desired user, and then select 'Edit User Privileges',
#' * in the 'Data Exports' radio buttons, select 'Full Data Set'.
#'
#' @section Pseudofields:
#'
#' The REDCap project may contain "pseudofields", depending on its structure.
#' Pseudofields are exported for certain project structures, but are not
#' defined by users and do not appear in the codebook.
Expand Down
13 changes: 12 additions & 1 deletion man/redcap_read.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 784fded

Please sign in to comment.