documentation for empty tibbles

ref #452
OuhscBbmc · Oct 23, 2022 · c934a8f · c934a8f
1 parent fcf42c3
commit c934a8f
Show file tree

Hide file tree

Showing 4 changed files with 16 additions and 0 deletions.
diff --git a/R/redcap-read-oneshot.R b/R/redcap-read-oneshot.R
@@ -106,6 +106,10 @@
 #' REDCap.  If an operation is successful, the `raw_text` is returned as an
 #' empty string to save RAM.
 #'
+#' If no records are retrieved (such as no records meet the filter criteria),
+#' a zero-row tibble is returned.
+#' Currently the empty tibble has zero columns, but that may change in the future.
+#'
 #' @details
 #' 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:

diff --git a/R/redcap-read.R b/R/redcap-read.R
@@ -114,6 +114,10 @@
 #' * `filter_logic`: The filter statement passed as an argument.
 #' * `elapsed_seconds`: The duration of the function.
 #'
+#' If no records are retrieved (such as no records meet the filter criteria),
+#' a zero-row tibble is returned.
+#' Currently the empty tibble has zero columns, but that may change in the future.
+#'
 #' @details
 #' [redcap_read()] internally uses multiple calls to [redcap_read_oneshot()]
 #' to select and return data.  Initially, only the primary key is queried

diff --git a/man/redcap_read.Rd b/man/redcap_read.Rd
diff --git a/man/redcap_read_oneshot.Rd b/man/redcap_read_oneshot.Rd