datalad export-redcap-project-xml
Synopsis
datalad export-redcap-project-xml [-h] [-d PATH] [--credential name] [--metadata-only] [--no-survey-fields] [-m MESSAGE] [--nosave] [--version] url outfile
Description
Export entire project (metadata & data) as a REDCap XML file
This exports all the project content (all records, events, arms, instruments, fields, and project attributes) as a single XML file. The file can be used to create a clone of the project on the same or another REDCap instance. It can also be useful for archival.
By default, the export will include all data as well. You can choose to export metadata only.
Note that when exporting data, Data Export user rights will be applied to any returned data. 'Full Data Set' export rights in the project are required to obtain everything.
Options
url
API URL to a REDCap server.
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.
--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.
--metadata-only
return only metadata (all fields, forms, events, and arms), do not include data.
--no-survey-fields
do not include survey identifier or survey timestamp fields.
-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