Better documentation about the export_survey_fields parameter

Thanks @isaactpetersen, closes #333

Author: wibeasley

NEWS.md

@@ -12,6 +12,7 @@ Version 0.12 (Unreleased on CRAN)
 * When writing records to the server, the functions `redcap_write()` and `redcap_write_oneshot()` have a new parameter that converts R's `logical`/boolean columns to integers.  This meshes well with T/F and Y/N items that are coded as 1/0 underneath. The default will be FALSE, so it doesn't break existing code. (#305)
 * When writing records to the server, the functions `redcap_write()` and `redcap_write_oneshot()` can toggle the ability to overwrite with blank/NA cells (suggested by @auricap, #315)
 * The functions `redcap_read_oneshot()`, `redcap_read()`, & `redcap_read_oneshot_eav()` now support the parameters `datetime_range_begin` and `datetime_range_end`.  The are passed to the REDCap parameters `dateRangeBegin` and `dateRangeEnd`, which restricts records returned, based on their last modified date in the server.  (Thanks @pbchase, #321 & #323.)
+* Better documentation about the `export_survey_fields` parameter in the functions `redcap_read()` & `redcap_read_oneshot()`.  (Thanks @isaactpetersen, #333)
 
 ### Stability Features
 

R/redcap-read-oneshot.R

@@ -35,7 +35,9 @@
 # placeholder: returnFormat
 #' @param export_survey_fields A boolean that specifies whether to export the
 #' survey identifier field (e.g., 'redcap_survey_identifier') or survey
-#' timestamp fields (e.g., instrument+'_timestamp') .
+#' timestamp fields (e.g., instrument+'_timestamp').
+#' The timestamp outputs reflect the survey's *completion* time
+#' (according to the time and timezone of the REDCap server.)
 #' @param export_data_access_groups A boolean value that specifies whether or
 #' not to export the `redcap_data_access_group` field when data access groups
 #' are utilized in the project. Default is `FALSE`. See the details below.

R/redcap-read.R

@@ -48,7 +48,9 @@
 #  placeholder: returnFormat
 #' @param export_survey_fields A boolean that specifies whether to export the
 #' survey identifier field (e.g., 'redcap_survey_identifier') or survey
-#' timestamp fields (e.g., instrument+'_timestamp') .
+#' timestamp fields (e.g., instrument+'_timestamp').
+#' The timestamp outputs reflect the survey's *completion* time
+#' (according to the time and timezone of the REDCap server.)
 #' @param export_data_access_groups A boolean value that specifies whether or
 #' not to export the `redcap_data_access_group` field when data access groups
 #' are utilized in the project. Default is `FALSE`. See the details below.