Skip to content

Using RS-BIDSIfy

Command line interface

convert

This command validates the input dataset metadata and structure, and then converts the input data to a BIDS-compliant dataset.
In normal usage, the convert command will skip existing BIDS-compatible data (e.g. existing subject directories/tasks) and will skip over recordings where an error is encountered. A summary of the status for each subject (and task) will be printed at the end of processing.
Each of these behaviours can be modified with the --force and --strict flags described below.

Usage

rs-bidsify convert path/to/raw/dataset path/to/output/dir

Option

The convert command includes a number of flags to adjust its operation:

  • --config: Specify a custom YAML configuration file
  • --logs: Specify a custom directory for log file output
  • --force/-f: Force overwrite of an existing dataset in the output location
  • --strict/-s: Stop immediately when an error is encountered