andreas/REDCapCAST
1
0
Fork 0
mirror of https://github.com/agdamsbo/REDCapCAST.git synced 2024-11-25 14:21:54 +01:00
Code Issues Packages Projects Releases Wiki Activity

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

Browse Source
This commit is contained in:
pegeler 2018-06-08 23:24:35 -04:00
parent bace4bb48b
commit e1ae1d001a
1 changed files with 39 additions and 10 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
R/R/REDCap_split.r
View File

@ -12,27 +12,56 @@
#' @author Paul W. Egeler, M.S., GStat #' @author Paul W. Egeler, M.S., GStat
#' @examples #' @examples
#' \dontrun{ #' \dontrun{
#' # Using an API call -------------------------------------------------------
#'
#' library(RCurl) #' library(RCurl)
#' #'
#' # Get the records #' # Get the records
#' records <- postForm( #' records <- postForm(
#' uri = api_url, # Supply your site-specific URI #' uri = api_url, # Supply your site-specific URI
#' token = api_token, # Supply your own API token #' token = api_token, # Supply your own API token
#' content = 'record', #' content = 'record',
#' format = 'json', #' format = 'json',
#' returnFormat = 'json' #' returnFormat = 'json'
#' ) #' )
#' #'
#' # Get the metadata #' # Get the metadata
#' metadata <- postForm( #' 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', #' content = 'metadata',
#' format = 'json' #' format = 'json'
#' ) #' )
#' #'
#' # Convert exported JSON strings into a list of data.frames #' # 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 #' @return A list of \code{"data.frame"}s: one base table and zero or more
#' tables for each repeating instrument. #' tables for each repeating instrument.