r-pkg: adding more examples. Will make some of them live with exdata in the future.

R/R/REDCap_split.r

@@ -12,6 +12,8 @@
 #' @author Paul W. Egeler, M.S., GStat
 #' @examples
 #' \dontrun{
+#' # Using an API call -------------------------------------------------------
+#'
 #' library(RCurl)
 #'
 #' # Get the records
@@ -25,14 +27,41 @@
 #'
 #' # Get the metadata
 #' metadata <- postForm(
-#'     uri = api_url,
+#'   uri = api_url,     # Supply your site-specific URI
-#'     token = api_token,
+#'   token = api_token, # Supply your own API token
 #'   content = 'metadata',
 #'   format = 'json'
 #' )
 #'
 #' # Convert exported JSON strings into a list of data.frames
-#' REDCap_split(records, metadata)
+#' REDCapRITS::REDCap_split(records, metadata)
+#'
+#' # Using a raw data export -------------------------------------------------
+#'
+#' # Get the records
+#' records <- read.csv("/path/to/data/ExampleProject_DATA_2018-06-03_1700.csv")
+#'
+#' # Get the metadata
+#' metadata <- read.csv("/path/to/data/ExampleProject_DataDictionary_2018-06-03.csv")
+#'
+#' # Split the tables
+#' REDCapRITS::REDCap_split(records, metadata)
+#'
+#' # In conjunction with the R export script ---------------------------------
+#'
+#' # You must set the working directory first since the REDCap data export script
+#' # contains relative file references.
+#' setwd("/path/to/data/")
+#'
+#' # Run the data export script supplied by REDCap.
+#' # This will create a data.frame of your records called 'data'
+#' source("ExampleProject_R_2018-06-03_1700.r")
+#'
+#' # Get the metadata
+#' metadata <- read.csv("ExampleProject_DataDictionary_2018-06-03.csv")
+#'
+#' # Split the tables
+#' REDCapRITS::REDCap_split(data, metadata)
 #' }
 #' @return A list of \code{"data.frame"}s: one base table and zero or more
 #'   tables for each repeating instrument.