This set of functions inspect a
data.frame to anticipate problems before writing with REDCap's API.
1 2 3 4 5
All functions listed in the Usage section above inspect a specific aspect of the dataset. The
validate_for_read() function executes all
these individual validation checks. It allows the client to check everything with one call.
data.frame, where each potential violation is a row. The two columns are:
field_name: The name of the
data.frame that might cause problems during the upload.
field_index: The position of the field. (For example, a value of '1' indicates the first column, while a '3' indicates the third column.)
concern: A description of the problem potentially caused by the
suggestion: A potential solution to the concern.
The official documentation can be found on the ‘API Help Page' and 'API Examples’ pages on the REDCap wiki (ie, https://community.projectredcap.org/articles/456/api-documentation.html and https://community.projectredcap.org/articles/462/api-examples.html). If you do not have an account for the wiki, please ask your campus REDCap administrator to send you the static material.
1 2 3 4 5 6