datalad export-redcap-form
Synopsis
datalad export-redcap-form [-h] [-d PATH] [--no-survey-fields] [--credential name] [-m MESSAGE] [--nosave] [--version] url form [form ...] outfile
Description
Export records from selected forms (instruments)
This is an equivalent to "Selected Instruments" export option in REDCap's interface. Allows saving response data from one or several forms into a single csv file.
Options
url
API URL to a REDCap server.
form
project form name(s).
outfile
file to write. Existing files will be overwritten.
-h, --help, --help-np
show this help message. --help-np forcefully disables the use of a pager for displaying the help message
-d PATH, --dataset PATH
the dataset in which the output file will be saved. The OUTFILE argument will be interpreted as being relative to this dataset. If no dataset is given, it will be identified based on the working directory.
--no-survey-fields
do not include survey identifier or survey timestamp fields.
--credential name
name of the credential providing a token to be used for authorization. If a match for the name is found, it will be used; otherwise the user will be prompted and the credential will be saved. If the name is not provided, the last-used credential matching the API url will be used if present; otherwise the user will be prompted and the credential will be saved under a default name.
-m MESSAGE, --message MESSAGE
a description of the state or the changes made to a dataset. Constraints: value must be a string or value must be NONE
--nosave
by default all modifications to a dataset are immediately saved. Giving this option will disable this behavior.
--version
show the module and its version which provides the command