datalad.api.export_redcap_report

datalad.api.export_redcap_report(url: str, report: str, outfile: Path, dataset: DatasetParameter | None = None, credential: str | None = None, message: str | None = None, save: bool = True)

Export a report of the Project

This is an equivalent to exporting a custom report via the "My Reports & Exports" page in REDCap's interface. A report must be defined through the REDCap's interface, and the user needs to look up its auto-generated report ID.

Parameters:

  • url -- API URL to a REDCap server.

  • report -- the report ID number, provided next to the report name on the report list page in REDCap UI.

  • 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]

  • 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']