datalad.api.export_redcap_project_xml

datalad.api.export_redcap_project_xml(url: str, outfile: Path, dataset: DatasetParameter | None = None, credential: str | None = None, metadata_only: bool = False, survey_fields: bool = True, message: str | None = None, save: bool = True)

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.

Parameters:

  • url -- API URL to a REDCap server.

  • outfile -- file to write. Existing files will be overwritten.

  • dataset -- 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. [Default: None]

  • credential -- 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. [Default: None]

  • metadata_only (bool, optional) -- return only metadata (all fields, forms, events, and arms), do not include data. [Default: False]

  • survey_fields (bool, optional) -- do not include survey identifier or survey timestamp fields. [Default: True]

  • message (str or None, optional) -- a description of the state or the changes made to a dataset. [Default: None]

  • save (bool, optional) -- by default all modifications to a dataset are immediately saved. Giving this option will disable this behavior. [Default: True]

  • on_failure ({'ignore', 'continue', 'stop'}, optional) -- behavior to perform on failure: 'ignore' any failure is reported, but does not cause an exception; 'continue' if any failure occurs an exception will be raised at the end, but processing other actions will continue for as long as possible; 'stop': processing will stop on first failure and an exception is raised. A failure is any result with status 'impossible' or 'error'. Raised exception is an IncompleteResultsError that carries the result dictionaries of the failures in its failed attribute. [Default: 'continue']

  • result_filter (callable or None, optional) -- if given, each to-be-returned status dictionary is passed to this callable, and is only returned if the callable's return value does not evaluate to False or a ValueError exception is raised. If the given callable supports **kwargs it will additionally be passed the keyword arguments of the original API call. [Default: None]

  • result_renderer -- select rendering mode command results. 'tailored' enables a command- specific rendering style that is typically tailored to human consumption, if there is one for a specific command, or otherwise falls back on the the 'generic' result renderer; 'generic' renders each result in one line with key info like action, status, path, and an optional message); 'json' a complete JSON line serialization of the full result record; 'json_pp' like 'json', but pretty-printed spanning multiple lines; 'disabled' turns off result rendering entirely; '<template>' reports any value(s) of any result properties in any format indicated by the template (e.g. '{path}', compare with JSON output for all key-value choices). The template syntax follows the Python "format() language". It is possible to report individual dictionary values, e.g. '{metadata[name]}'. If a 2nd-level key contains a colon, e.g. 'music:Genre', ':' must be substituted by '#' in the template, like so: '{metadata[music#Genre]}'. [Default: 'tailored']

  • result_xfm ({'datasets', 'successdatasets-or-none', 'paths', 'relpaths', 'metadata'} or callable or None, optional) -- if given, each to-be-returned result status dictionary is passed to this callable, and its return value becomes the result instead. This is different from result_filter, as it can perform arbitrary transformation of the result value. This is mostly useful for top- level command invocations that need to provide the results in a particular format. Instead of a callable, a label for a pre-crafted result transformation can be given. [Default: None]

  • return_type ({'generator', 'list', 'item-or-list'}, optional) -- return value behavior switch. If 'item-or-list' a single value is returned instead of a one-item return value list, or a list in case of multiple return values. None is return in case of an empty list. [Default: 'list']