Skip to content

Latest commit

History

632 Commits

Folders and files

NameName
Last commit message
Last commit date

Repository files navigation

GitHub Actions

bids-examples

This repository contains a set of BIDS-compatible datasets with empty raw data files. These datasets can be useful to:

  1. write lightweight software tests
  2. serve as an example on how a BIDS dataset can be structured

ALL RAW DATA FILES IN THIS REPOSITORY ARE EMPTY!

However for some of the data, the headers containing the metadata are still intact. (For example the NIfTI headers for .nii files, the BrainVision data headers for .vhdr files, or the OME-XML headers for .ome.tif files.)

Headers are intact for the following datasets:

  • synthetic
  • Most EEG or iEEG data in BrainVision format (e.g., eeg_matchingpennies)

Validating BIDS examples

The next three sections mention a few details on how the bids-examples can be validated using bids-validator.

For general information on the bids-validator, including installation and usage, see the bids-validator README file.

Validating individual examples

Since all raw data files in this repository are empty, the bids-validator must to be configured to not report empty data files as errors. (See more on bids-validator configuration in the bids-validator README.)

Just run the validator as follows (using the eeg_matchingpennies dataset as an example, and assuming you are in a command line at the root of the bids-examples repository):

bids-validator eeg_matchingpennies --config.ignore=99

The --config.ignore=99 "flag" tells the bids-validator to ignore empty data files rather than to report the "empty file" error .

For datasets that contain NIfTI .nii files, you also need to add the ignoreNiftiHeaders flag to the bids-validator call, to suppress the issue that NIfTI headers are not found.

For example:

bids-validator ds003 --config.ignore=99 --ignoreNiftiHeaders

Validating all examples

If you want to validate all examples in one go, you can use the run_tests.sh script that is provided in this repository. This script makes use of the bidsconfig.json configuration file for the bids-validator, and appropriately handles some special case examples (see Validator Exceptions).

Simply run bash run_tests.sh in a command line from the root of the bids-examples repository.

Validator exceptions

Some datasets may include a custom .bids-validator-config.json to ignore errors generated from idiosyncracies of the datasets as they existed on creation.

nameerrors ignored
genetics_ukbbSliceTiming values for tasks is larger than given TR, EchoTime1 and EchoTime2 are not provided for any of the phasediff files.

Other datasets may include a .SKIP_VALIDATION file, to skip the validation with the continuous integration service. This is useful for datasets that cannot pass at the moment due to lack of coverage in the bids-validator.

Note however, that the .SKIP_VALIDATION file only impacts the continuous integration service, or validation when run with the run_tests.sh script (see Validating all examples). This file does not have any effect when running bids-validator from custom scripts, the web-based validator, docker, or from the command line.

namewhy skipped
ds000001-fmripreplack of coverage for "derivatives" in bids-validator

Contributing

We are happy to receive contributions in the form of:

  • updates to existing examples, or the dataset index
  • new examples
    • only if they cover aspects that are currently not covered by existing examples
    • only if a maintainer can be found for this dataset
  • suggestions on how to improve the bids-examples repository

For more information, please see our CONTRIBUTING.md file or open a new GitHub Issue and ask us directly.

Dataset index

Below you find several tables with information about the datasets available in bids-examples (in alphabetical order).

EEG datasets

namemaintained bydescriptionlink to full data
eeg_matchingpennies@sappelhoffOffline data of BCI experiment decoding left vs. right hand movement. BrainVision data format (.eeg, .vhdr, .vmrk)https://doi.org/10.17605/OSF.IO/CJ2DR
eeg_rishikesh@arnodelormeMind wandering experiment. EEG data in Biosemi (.bdf) formathttps://openneuro.org/datasets/ds001787
eeg_face13@andeshaDeconstructing the early visual electrocortical response to face and house stimuli. EDF format
eeg_ds003654s_hed@VisLabShows usage of Hierarchical Event Descriptor (HED) in events fileshttps://openneuro.org/datasets/ds003645
eeg_ds003654s_hed_inheritance@VisLabHED annotation with multiple inherited sidecarshttps://openneuro.org/datasets/ds003645
eeg_ds003654s_hed_longform@VisLabHED annotation using tags in long form.https://openneuro.org/datasets/ds003645
eeg_ds003654s_hed_library@VisLabHED annotation using HED library vocabularies (schema).https://openneuro.org/datasets/ds003645
eeg_cbm@cpernetRest EEG. European Data Format (.edf)

iEEG datasets

namemaintained bydescription
ieeg_filtered_speech@choldgrafrecordings of three seizures
ieeg_motorMiller2007@dorahermesCue-based hand & tongue movement data
ieeg_visual@dorahermesStimulus dependence of gamma oscillations in human visual cortex

MRI datasets

namemaintained bydescriptionfuncanatotherlink to link to full data
7t_trtbold, physioT1w, quantitative T1 mapsfmaphttps://bit.ly/2H0Z6Qt
ds001single task, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000001/versions/00006
ds002multiple tasks, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000002/versions/00002
ds003single task, single runbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000003/versions/00001
ds005single task, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000005/versions/00001
ds006single task, multiple sessions, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000006/versions/00001
ds007single task, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000007/versions/00001
ds008multiple tasks, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000008/versions/00001
ds009multiple tasks, multiple runsbold, eventsT1w, in-plane T2https://openneuro.org/datasets/ds000009/versions/00002
ds011multiple tasks, multiple runsboldT1whttps://openneuro.org/datasets/ds000011/versions/00001
ds051multiple tasks, multiple runsboldT1w, in-plane T2https://openneuro.org/datasets/ds000051/versions/00001
ds052multiple tasks, multiple runsboldT1w, in-plane T2https://openneuro.org/datasets/ds000052/versions/00001
ds101single task, multiple runsboldT1whttps://openneuro.org/datasets/ds000101/versions/00004
ds102single task, multiple runsboldT1whttps://openneuro.org/datasets/ds000102/versions/00001
ds105single task, multiple runsboldT1whttps://openneuro.org/datasets/ds000105/versions/00001
ds107single task, multiple runsboldT1whttps://openneuro.org/datasets/ds000107/versions/00001
ds108single task, multiple runsboldT1whttps://openneuro.org/datasets/ds000108/versions/00002
ds109multiple tasks, multiple runsboldT1whttps://openneuro.org/datasets/ds000109/versions/00001
ds110single task, multiple runsboldT1w, in-plane T2https://openneuro.org/datasets/ds000110/versions/00001
ds113bforrest gump watching, multiple sessions, multiple runsboldT1w, T2wangiography, dwi, fmaphttps://openneuro.org/datasets/ds000113/versions/1.3.0
ds114multiple tasks, multiple runsboldT1wDWIhttps://openneuro.org/datasets/ds000114/versions/1.0.1
ds116multiple tasks, multiple runsboldT1w, in-plane T2https://openneuro.org/datasets/ds000116/versions/00003
ds210multiple tasks, multiple runsboldT1whttps://openneuro.org/datasets/ds000210/versions/00002
hcp_example_bids@robertoostenveldboldT1whttps://bit.ly/2H0Z6Qt
synthetic@effigiesA synthetic datasetboldT1wn/a
ds000001-fmriprep@effigiesCommon derivatives exampleboldT1whttps://openneuro.org/datasets/ds000001/versions/1.0.0

ASL datasets

namemaintained bydescriptionlink to link to full data
asl001@patsycleT1w, asl (GE, PCASL, 3D_SPIRAL), m0scan within timeserieshttps://osf.io/yru2q/
asl002@patsycleT1w, asl (Philips, PCASL, 2D_EPI), m0scan as separate scanhttps://osf.io/yru2q/
asl003@patsycleT1w, asl (Siemens, PASL, multiTI), M0scan as separate scanhttps://osf.io/yru2q/
asl004@patsycleT1w, asl (Siemens, PCASL, multiPLD with pepolar), m0scan separate scans with pepolar appraochhttps://osf.io/yru2q/
asl005@patsycleT1w, asl (Siemens, PCASL, singleTI, 3D_GRASE), m0scan as separate scanhttps://osf.io/yru2q/

qMRI datasets

namemaintained bydescriptionlink to link to full data
qmri_mp2rage@Gilles86MP2RAGE for T1 mappinghttps://osf.io/k4bs5/
qmri_mp2rageme@Gilles86Multi-echo MP2RAGEhttps://osf.io/k4bs5/
qmri_mpm@ChristophePhillipsMulti-parametric mapping for R1, R2star, MTsat and PD mappinghttps://osf.io/k4bs5/
qmri_mtsat@agahkarakuzuExample dataset for T1 and MTsat mapping. Includes a double-angle B1+ mapping example.https://osf.io/k4bs5/
qmri_qsm@agahkarakuzuChimap using fast QSMnot publicly availabe
qmri_sa2rage@agahkarakuzuFast B1+ mapping using SA2RAGEnot publicly availabe
qmri_vfa@agahkarakuzuVariable Flip Angle T1 mapping. Includes an Actual Flip Angle (AFI) B1+ mapping example.https://osf.io/k4bs5/
qmri_irt1@agahkarakuzuInversion Recovery T1 mappingnot publicly availabe
qmri_mese@agahkarakuzuMulti-Echo Spin-Echo for T2 or Myelin Water Fraction (MWF) mapping.not publicly availabe
qmri_megre@agahkarakuzuMulti-Echo Gradient-Echo for T2star mapping.not publicly availabe
qmri_tb1tfl@agahkarakuzuB1+ mapping with TurboFLASH readout.not publicly availabe

PET datasets

namemaintained bydescriptionlink to full data
pet001@mnoergaardT1w, PET, blood
pet002@mnoergaardT1w, PEThttps://openneuro.org/datasets/ds001420/
pet003@mnoergaardT1w, PET, blood
pet004@mnoergaardPET, blood
pet005@mnoergaardT1w, PET

Microscopy datasets

namemaintained bydescription
micr_SEM@jcohenadadExample SEM dataset in PNG format with 1 sample imaged over 2 sessions
micr_SEMzarr@TheChymeraExample SEM dataset in PNG and OME-ZARR format with 1 sample imaged over 2 sessions
micr_SPIM@jcohenadadExample SPIM dataset in OME-TIFF format with 2 samples from the same subject with 4 chunks each

NIRS datasets

namemaintained bydescriptionlink to full data
fnirs_tapping@rob_lukeExample fNIRS measurement with three conditions from five subjectshttps://doi.org/10.5281/zenodo.5529797
fnirs_automaticiy@robertoostenveld24 subjects performing (non-)automatic finger tapping and foot steppinghttps://doi.org/10.34973/vesb-mh30

Multimodal datasets

namemaintained bydescriptionmrimegeegieeggeneticslink to full data
ds000117@RikHensonA multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual taskanat, dwi, func, fmapmegeeghttps://openneuro.org/datasets/ds000117/
ds000246@guiomarAuditory dataset used for Brainstorm’s general online tutorialanatmeghttps://openneuro.org/datasets/ds000246/versions/00001
ds000247@guiomarFive minutes, eyes-open, resting-state MEG data from 5 subjects. This is a sample from The Open MEG Archive (OMEGA).anatmeghttps://openneuro.org/datasets/ds000247/versions/00001
ds000248@agramfortMNE sample data: Data with visual and auditory stimulianatmeghttps://openneuro.org/datasets/ds000248/versions/00001
eeg_ds000117@robertoostenveldMultimodal (fMRI, MEG, EEG) stripped down to EEG with MRI anatomical scan and electrode coordinates. EEGLAB data format (.set, .fdt)anateeghttps://openneuro.org/datasets/ds000117/
eeg_rest_fmri@cpernetResting state with simultaneous fMRI. BrainVision data format (.eeg, .vhdr, .vmrk)anat, dwi, funceeg
ieeg_epilepsy@ftadelmultiple sessions, tutorialanatieeghttps://neuroimage.usc.edu/bst/getupdate.php?s=tutorial_epimap_bids
ieeg_epilepsy_ecog@ftadelmultiple sessions, tutorialanatieeghttps://neuroimage.usc.edu/bst/getupdate.php?s=sample_ecog
ieeg_visual_multimodal@irisgroenanat, fmap, funcieeg
genetics_ukbb@cpernetmultiple tasks, T1w, DTI, BOLD, genetic infoanat, dwi, func, fmapgenetics

About

A set of BIDS compatible datasets with empty raw data files that can be used for writing lightweight software tests.

Resources

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages