andreas/REDCapCAST
1
0
Fork 0
mirror of https://github.com/agdamsbo/REDCapCAST.git synced 2024-11-22 13:30:23 +01:00
Code Issues Packages Projects Releases Wiki Activity

Adding detail to README.md regarding R usage.

Browse Source
This commit is contained in:
Egeler, Paul W 2018-06-06 18:34:43 -04:00
parent 91d9e8e8dd
commit f826571c2c
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
README.md
View File

@ -49,7 +49,13 @@ devtools::install_github("SpectrumHealthResearch/REDCapRITS/R")
After the package is installed, follow these instructions: After the package is installed, follow these instructions:
1. Download the record dataset and metadata. This can 1. Download the record dataset and metadata. This can
be accomplished either by traditional methods or using the API. be accomplished by several methods:
- Using the API. Check with your REDCap administrator for details.
- Exporting the data from the web interface by selecting *CSV / Microsoft Excel (raw data)*.
- Exporting the data from the web interface by selecting *R Statistical Software*.
If you use this method, you may run the R script supplied by REDCap prior to splitting the data.
- **Do NOT** export from the web interface with the *CSV / Microsoft Excel (labels)* option.
This will not work with REDCapRITS.
1. Call the function, pointing it to your record dataset and metadata 1. Call the function, pointing it to your record dataset and metadata
`data.frame`s or JSON character vectors. You may need to load the package via `data.frame`s or JSON character vectors. You may need to load the package via
`library()` or `require()`. `library()` or `require()`.
@ -82,7 +88,7 @@ metadata <- postForm(
REDCapRITS::REDCap_split(records, metadata) REDCapRITS::REDCap_split(records, metadata)
``` ```
And here is an example of usage when downloading a REDCap export manually from your REDCap web interface: And here is an example of usage when downloading a REDCap export of the raw data (not labelled!) manually from your REDCap web interface:
```r ```r
# Get the records # Get the records