Home

Welcome to the EEG2BIDS wiki! This tool has also been called PyCat by the dev team at the McGill Centre for Integrative Neuroscience

This tool is designed to run on Windows and mac and make BIDS conversion of data easier for non-technical users.

• Windows release is available at: https://github.com/aces/EEG2BIDS/releases/
• Mac needs to be built from scratch (see Readme)

In Scope:

• EDF files
• Template for ieeg.json and eeg.json can be found here. This is a subset of all recommended/required fields -- Required fields are asked directly by the Wizard (Frequency, etc)
• The wizard currently runs only one Task at a time -- continuous or discontinuous - that captures the same experimental context/setup. Any change in e.g. channels should mark the start of a new "task"
• The wizard can process a single task with multiple runs (see BIDS definition) in one go. For these multi-run tasks, add the -run1, -run2 suffix for each input file to identify them, e.g. :

[filename1] = SubjectID_VisitLabel_task01-run1.edf
[filename2] = SubjectID_VisitLabel_task01-run2.edf

• For a session with multiple "tasks" -- these must be combined manually by putting all files under the same sessionfolder, and creating a single (merged) scans.tsv file
• JSON files provided by user will be checked/flagged for JSON formatting issues. Spaces and special chars are stripped/disabled where possible.
• Validation of any BIDS directory (even MRI) can be done under the Validate tab
• LORIS project users can log into a LORIS to verify the IDs (PSCID and DCCID).

Out of scope / future roadmap

• split files, other validation or conversion not supported by the MNE-BIDS libraries.
• Creating a candidate in LORIS -- Option hidden from Config panel. Needs refactoring since every time the Validate tab is clicked a candidate is created. (?and visit?)
• running BIDS validator on annotations files - no spec has been published for BEP021, so the MNE-BIDS library does not validate these files, but if supplied they will be included

Caveats:

• The NAME field in dataset_description.json will be the PatientID_SessionLabel (and for LORIS: PSCID_VisitLabel) Note that since the Wizard can only process one task at a time, this Name will be the same for multiple output folders. You may wish to add taskname in this field for this reason.
• Not all BIDS default values are checked. e.g. if a user types n\a instead of n/a, this tool may not catch it.

Developer procedures for new versions

Updating the Version number

Issuing a new .exe release (for Windows)

Citation:

How to cite this tool: Please also cite MNE-BIDS for the core library