From 6672bd610c9f6b02680758817fc1bf8d9fc5af53 Mon Sep 17 00:00:00 2001 From: Remi Gau Date: Fri, 14 Jun 2024 12:28:27 +0200 Subject: [PATCH] [ENH] allow script listing datasets to dump content in another file --- README.md | 96 +++++++++++++++++----------------- dataset_listing.tsv | 10 ++-- tools/print_dataset_listing.py | 17 ++++-- 3 files changed, 68 insertions(+), 55 deletions(-) diff --git a/README.md b/README.md index 8e0afd77b..02901f0ff 100644 --- a/README.md +++ b/README.md @@ -175,7 +175,7 @@ DO NOT EDIT DIRECTLY. | name | description | datatypes | suffixes | link to full data | maintained by | |:--------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------|:--------------------------------|:------------------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-------------------------------------------| -| [ds000117](https://github.com/bids-standard/bids-examples/tree/master/ds000117) | A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task | anat, beh, dwi, fmap, func, meg | T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans | [link](https://openneuro.org/datasets/ds000117/) | [@RikHenson](https://github.com/RikHenson) | +| [ds000117](https://github.com/bids-standard/bids-examples/tree/master/ds000117) | A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task | anat, beh, dwi, fmap, func, meg | FLASH, T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans | [link](https://openneuro.org/datasets/ds000117/) | [@RikHenson](https://github.com/RikHenson) | | [ds000246](https://github.com/bids-standard/bids-examples/tree/master/ds000246) | Auditory dataset used for Brainstorm’s general online tutorial | anat, meg | ChannelGroupSet, ClassFile, MarkerFile, T1w, channels, coordsystem, default, headshape, meg, params, photo, processing, scans | [link](https://openneuro.org/datasets/ds000246/versions/00001) | [@guiomar](https://github.com/guiomar) | | [ds000247](https://github.com/bids-standard/bids-examples/tree/master/ds000247) | Five minutes, eyes-open, resting-state MEG data from 5 subjects. This is a sample from The Open MEG Archive (OMEGA). | anat, meg | ClassFile, T1w, bad, channels, coordsystem, default, headshape, meg, params, processing, scans | [link](https://openneuro.org/datasets/ds000247/versions/00001) | [@guiomar](https://github.com/guiomar) | | [ds000248](https://github.com/bids-standard/bids-examples/tree/master/ds000248) | MNE sample data: Data with visual and auditory stimuli | anat, meg | FLASH, T1w, channels, coordsystem, events, meg, scans | [link](https://openneuro.org/datasets/ds000248/versions/00001) | [@agramfort](https://github.com/agramfort) | @@ -187,11 +187,12 @@ TABLE BELOW IS GENERATED AUTOMATICALLY. DO NOT EDIT DIRECTLY. --> -| name | description | datatypes | suffixes | link to full data | maintained by | -|:----------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------|:------------|:------------------------------|:-----------------------------------------------|:---------------------------------------------| -| [micr_SEM](https://github.com/bids-standard/bids-examples/tree/master/micr_SEM) | Example SEM dataset in PNG format with 1 sample imaged over 2 sessions | micr | SEM, photo, samples, sessions | [link](https://doi.org/10.5281/zenodo.5498378) | [@jcohenadad](https://github.com/jcohenadad) | -| [micr_SEMzarr](https://github.com/bids-standard/bids-examples/tree/master/micr_SEMzarr) | Example SEM dataset in PNG and OME-ZARR format with 1 sample imaged over 2 sessions | micr | SEM, samples, sessions | n/a | [@TheChymera](https://github.com/TheChymera) | -| [micr_SPIM](https://github.com/bids-standard/bids-examples/tree/master/micr_SPIM) | Example SPIM dataset in OME-TIFF format with 2 samples from the same subject with 4 chunks each | micr | SPIM, photo, samples | [link](https://doi.org/10.5281/zenodo.5517223) | [@jcohenadad](https://github.com/jcohenadad) | +| name | description | datatypes | suffixes | link to full data | maintained by | +|:------------------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------|:------------------------------------------------|:---------------------------------------------| +| [eeg_ds003645s_hed_demo](https://github.com/bids-standard/bids-examples/tree/master/eeg_ds003645s_hed_demo) | Shows usage of Hierarchical Event Descriptor (HED) in .tsv files | anat, beh, eeg, micr, motion | KSSSleep, SPIM, beh, channels, coordsystem, defacemask, eeg, electrodes, events, headshape, motion, photo, samples, scans | [link](https://openneuro.org/datasets/ds003645) | [@VisLab](https://github.com/VisLab) | +| [micr_SEM](https://github.com/bids-standard/bids-examples/tree/master/micr_SEM) | Example SEM dataset in PNG format with 1 sample imaged over 2 sessions | micr | SEM, photo, samples, sessions | [link](https://doi.org/10.5281/zenodo.5498378) | [@jcohenadad](https://github.com/jcohenadad) | +| [micr_SEMzarr](https://github.com/bids-standard/bids-examples/tree/master/micr_SEMzarr) | Example SEM dataset in PNG and OME-ZARR format with 1 sample imaged over 2 sessions | micr | SEM, SPIM, samples, sessions | n/a | [@TheChymera](https://github.com/TheChymera) | +| [micr_SPIM](https://github.com/bids-standard/bids-examples/tree/master/micr_SPIM) | Example SPIM dataset in OME-TIFF format with 2 samples from the same subject with 4 chunks each | micr | SPIM, photo, samples | [link](https://doi.org/10.5281/zenodo.5517223) | [@jcohenadad](https://github.com/jcohenadad) | ### Motion @@ -200,11 +201,12 @@ TABLE BELOW IS GENERATED AUTOMATICALLY. DO NOT EDIT DIRECTLY. --> -| name | description | datatypes | suffixes | link to full data | maintained by | -|:--------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------|:------------|:--------------------------------------------------------------|:--------------------------------------------------------|:-------------------------------------------------| -| [motion_dualtask](https://github.com/bids-standard/bids-examples/tree/master/motion_dualtask) | older and younger participants walking while performing discrimination task | eeg, motion | channels, eeg, events, motion, scans | n/a | [@sjeung](https://github.com/sjeung) | -| [motion_spotrotation](https://github.com/bids-standard/bids-examples/tree/master/motion_spotrotation) | participants rotated heading using full-body motion or joystick | eeg, motion | channels, coordsystem, eeg, electrodes, events, motion, scans | [link](https://openneuro.org/datasets/ds004460) | [@sjeung](https://github.com/sjeung) | -| [motion_systemvalidation](https://github.com/bids-standard/bids-examples/tree/master/motion_systemvalidation) | Example dataset of two different motion captured system recorded almost simultaneously, but no brain data | motion | channels, motion, scans | [link](https://doi.org/10.6084/m9.figshare.20238006.v2) | [@JuliusWelzel](https://github.com/JuliusWelzel) | +| name | description | datatypes | suffixes | link to full data | maintained by | +|:--------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------|:-----------------------------|:--------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------|:-------------------------------------------------| +| [eeg_ds003645s_hed_demo](https://github.com/bids-standard/bids-examples/tree/master/eeg_ds003645s_hed_demo) | Shows usage of Hierarchical Event Descriptor (HED) in .tsv files | anat, beh, eeg, micr, motion | KSSSleep, SPIM, beh, channels, coordsystem, defacemask, eeg, electrodes, events, headshape, motion, photo, samples, scans | [link](https://openneuro.org/datasets/ds003645) | [@VisLab](https://github.com/VisLab) | +| [motion_dualtask](https://github.com/bids-standard/bids-examples/tree/master/motion_dualtask) | older and younger participants walking while performing discrimination task | eeg, motion | channels, eeg, events, motion, scans | n/a | [@sjeung](https://github.com/sjeung) | +| [motion_spotrotation](https://github.com/bids-standard/bids-examples/tree/master/motion_spotrotation) | participants rotated heading using full-body motion or joystick | eeg, motion | channels, coordsystem, eeg, electrodes, events, motion, scans | [link](https://openneuro.org/datasets/ds004460) | [@sjeung](https://github.com/sjeung) | +| [motion_systemvalidation](https://github.com/bids-standard/bids-examples/tree/master/motion_systemvalidation) | Example dataset of two different motion captured system recorded almost simultaneously, but no brain data | motion | channels, motion, scans | [link](https://doi.org/10.6084/m9.figshare.20238006.v2) | [@JuliusWelzel](https://github.com/JuliusWelzel) | ### MRI @@ -213,36 +215,36 @@ TABLE BELOW IS GENERATED AUTOMATICALLY. DO NOT EDIT DIRECTLY. --> -| name | description | datatypes | suffixes | link to full data | maintained by | -|:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------------------------|:-------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-------------------------------------------| -| [7t_trt](https://github.com/bids-standard/bids-examples/tree/master/7t_trt) | n/a | anat, fmap, func | T1map, T1w, bold, magnitude1, magnitude2, phasediff, physio, scans, sessions | [link](https://bit.ly/2H0Z6Qt) | n/a | -| [ds000117](https://github.com/bids-standard/bids-examples/tree/master/ds000117) | A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task | anat, beh, dwi, fmap, func, meg | T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans | [link](https://openneuro.org/datasets/ds000117/) | [@RikHenson](https://github.com/RikHenson) | -| [ds001](https://github.com/bids-standard/bids-examples/tree/master/ds001) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000001/versions/00006) | n/a | -| [ds002](https://github.com/bids-standard/bids-examples/tree/master/ds002) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000002/versions/00002) | n/a | -| [ds003](https://github.com/bids-standard/bids-examples/tree/master/ds003) | single task, single run | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000003/versions/00001) | n/a | -| [ds005](https://github.com/bids-standard/bids-examples/tree/master/ds005) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000005/versions/00001) | n/a | -| [ds006](https://github.com/bids-standard/bids-examples/tree/master/ds006) | single task, multiple sessions, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000006/versions/00001) | n/a | -| [ds007](https://github.com/bids-standard/bids-examples/tree/master/ds007) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000007/versions/00001) | n/a | -| [ds008](https://github.com/bids-standard/bids-examples/tree/master/ds008) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000008/versions/00001) | n/a | -| [ds009](https://github.com/bids-standard/bids-examples/tree/master/ds009) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2, scans | [link](https://openneuro.org/datasets/ds000009/versions/00002) | n/a | -| [ds011](https://github.com/bids-standard/bids-examples/tree/master/ds011) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000011/versions/00001) | n/a | -| [ds051](https://github.com/bids-standard/bids-examples/tree/master/ds051) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000051/versions/00001) | n/a | -| [ds052](https://github.com/bids-standard/bids-examples/tree/master/ds052) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000052/versions/00001) | n/a | -| [ds101](https://github.com/bids-standard/bids-examples/tree/master/ds101) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000101/versions/00004) | n/a | -| [ds102](https://github.com/bids-standard/bids-examples/tree/master/ds102) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000102/versions/00001) | n/a | -| [ds105](https://github.com/bids-standard/bids-examples/tree/master/ds105) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000105/versions/00001) | n/a | -| [ds107](https://github.com/bids-standard/bids-examples/tree/master/ds107) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000107/versions/00001) | n/a | -| [ds108](https://github.com/bids-standard/bids-examples/tree/master/ds108) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000108/versions/00002) | n/a | -| [ds109](https://github.com/bids-standard/bids-examples/tree/master/ds109) | multiple tasks, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000109/versions/00001) | n/a | -| [ds110](https://github.com/bids-standard/bids-examples/tree/master/ds110) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000110/versions/00001) | n/a | -| [ds113b](https://github.com/bids-standard/bids-examples/tree/master/ds113b) | forrest gump watching, multiple sessions, multiple runs | func | bold, events | [link](https://openneuro.org/datasets/ds000113/versions/1.3.0) | n/a | -| [ds114](https://github.com/bids-standard/bids-examples/tree/master/ds114) | multiple tasks, multiple runs | anat, dwi, func | T1w, bold, dwi, events | [link](https://openneuro.org/datasets/ds000114/versions/1.0.1) | n/a | -| [ds116](https://github.com/bids-standard/bids-examples/tree/master/ds116) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000116/versions/00003) | n/a | -| [ds210](https://github.com/bids-standard/bids-examples/tree/master/ds210) | multiple tasks, multiple runs | func | bold, physio | [link](https://openneuro.org/datasets/ds000210/versions/00002) | n/a | -| [eeg_rest_fmri](https://github.com/bids-standard/bids-examples/tree/master/eeg_rest_fmri) | Resting state with simultaneous fMRI. BrainVision data format (.eeg, .vhdr, .vmrk) | anat, dwi, eeg, func | T1w, bold, dwi, eeg | n/a | [@cpernet](https://github.com/cpernet) | -| [genetics_ukbb](https://github.com/bids-standard/bids-examples/tree/master/genetics_ukbb) | multiple tasks, T1w, DTI, BOLD, genetic info | anat, dwi, fmap, func | FLAIR, T1w, bold, dwi, events, info, magnitude1, phasediff | n/a | [@cpernet](https://github.com/cpernet) | -| [ieeg_visual_multimodal](https://github.com/bids-standard/bids-examples/tree/master/ieeg_visual_multimodal) | n/a | anat, fmap, func, ieeg | T1w, bold, channels, coordsystem, electrodes, epi, events, ieeg, sbref | n/a | [@irisgroen](https://github.com/irisgroen) | -| [synthetic](https://github.com/bids-standard/bids-examples/tree/master/synthetic) | A synthetic dataset | anat, beh, func | T1w, beh, bold, events, physio, scans, sessions, stim | n/a | [@effigies](https://github.com/effigies) | +| name | description | datatypes | suffixes | link to full data | maintained by | +|:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------------------------|:--------------------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------|:-------------------------------------------| +| [7t_trt](https://github.com/bids-standard/bids-examples/tree/master/7t_trt) | n/a | anat, fmap, func | T1map, T1w, bold, magnitude1, magnitude2, phasediff, physio, scans, sessions | [link](https://bit.ly/2H0Z6Qt) | n/a | +| [ds000117](https://github.com/bids-standard/bids-examples/tree/master/ds000117) | A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task | anat, beh, dwi, fmap, func, meg | FLASH, T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans | [link](https://openneuro.org/datasets/ds000117/) | [@RikHenson](https://github.com/RikHenson) | +| [ds001](https://github.com/bids-standard/bids-examples/tree/master/ds001) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000001/versions/00006) | n/a | +| [ds002](https://github.com/bids-standard/bids-examples/tree/master/ds002) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000002/versions/00002) | n/a | +| [ds003](https://github.com/bids-standard/bids-examples/tree/master/ds003) | single task, single run | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000003/versions/00001) | n/a | +| [ds005](https://github.com/bids-standard/bids-examples/tree/master/ds005) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000005/versions/00001) | n/a | +| [ds006](https://github.com/bids-standard/bids-examples/tree/master/ds006) | single task, multiple sessions, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000006/versions/00001) | n/a | +| [ds007](https://github.com/bids-standard/bids-examples/tree/master/ds007) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000007/versions/00001) | n/a | +| [ds008](https://github.com/bids-standard/bids-examples/tree/master/ds008) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000008/versions/00001) | n/a | +| [ds009](https://github.com/bids-standard/bids-examples/tree/master/ds009) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2, scans | [link](https://openneuro.org/datasets/ds000009/versions/00002) | n/a | +| [ds011](https://github.com/bids-standard/bids-examples/tree/master/ds011) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000011/versions/00001) | n/a | +| [ds051](https://github.com/bids-standard/bids-examples/tree/master/ds051) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000051/versions/00001) | n/a | +| [ds052](https://github.com/bids-standard/bids-examples/tree/master/ds052) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000052/versions/00001) | n/a | +| [ds101](https://github.com/bids-standard/bids-examples/tree/master/ds101) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000101/versions/00004) | n/a | +| [ds102](https://github.com/bids-standard/bids-examples/tree/master/ds102) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000102/versions/00001) | n/a | +| [ds105](https://github.com/bids-standard/bids-examples/tree/master/ds105) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000105/versions/00001) | n/a | +| [ds107](https://github.com/bids-standard/bids-examples/tree/master/ds107) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000107/versions/00001) | n/a | +| [ds108](https://github.com/bids-standard/bids-examples/tree/master/ds108) | single task, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000108/versions/00002) | n/a | +| [ds109](https://github.com/bids-standard/bids-examples/tree/master/ds109) | multiple tasks, multiple runs | anat, func | T1w, bold, events | [link](https://openneuro.org/datasets/ds000109/versions/00001) | n/a | +| [ds110](https://github.com/bids-standard/bids-examples/tree/master/ds110) | single task, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000110/versions/00001) | n/a | +| [ds113b](https://github.com/bids-standard/bids-examples/tree/master/ds113b) | forrest gump watching, multiple sessions, multiple runs | func | bold, events | [link](https://openneuro.org/datasets/ds000113/versions/1.3.0) | n/a | +| [ds114](https://github.com/bids-standard/bids-examples/tree/master/ds114) | multiple tasks, multiple runs | anat, dwi, func | T1w, bold, dwi, events | [link](https://openneuro.org/datasets/ds000114/versions/1.0.1) | n/a | +| [ds116](https://github.com/bids-standard/bids-examples/tree/master/ds116) | multiple tasks, multiple runs | anat, func | T1w, bold, events, inplaneT2 | [link](https://openneuro.org/datasets/ds000116/versions/00003) | n/a | +| [ds210](https://github.com/bids-standard/bids-examples/tree/master/ds210) | multiple tasks, multiple runs | func | bold, physio | [link](https://openneuro.org/datasets/ds000210/versions/00002) | n/a | +| [eeg_rest_fmri](https://github.com/bids-standard/bids-examples/tree/master/eeg_rest_fmri) | Resting state with simultaneous fMRI. BrainVision data format (.eeg, .vhdr, .vmrk) | anat, dwi, eeg, func | T1w, bold, dwi, eeg | n/a | [@cpernet](https://github.com/cpernet) | +| [genetics_ukbb](https://github.com/bids-standard/bids-examples/tree/master/genetics_ukbb) | multiple tasks, T1w, DTI, BOLD, genetic info | anat, dwi, func | FLAIR, T1w, bold, dwi, events, info | n/a | [@cpernet](https://github.com/cpernet) | +| [ieeg_visual_multimodal](https://github.com/bids-standard/bids-examples/tree/master/ieeg_visual_multimodal) | n/a | anat, fmap, func, ieeg | T1w, bold, channels, coordsystem, electrodes, epi, events, ieeg, sbref | n/a | [@irisgroen](https://github.com/irisgroen) | +| [synthetic](https://github.com/bids-standard/bids-examples/tree/master/synthetic) | A synthetic dataset | anat, beh, func | T1w, beh, bold, events, physio, scans, sessions, stim | n/a | [@effigies](https://github.com/effigies) | ### NIRS @@ -283,7 +285,7 @@ DO NOT EDIT DIRECTLY. | [qmri_irt1](https://github.com/bids-standard/bids-examples/tree/master/qmri_irt1) | Inversion Recovery T1 mapping | anat | IRT1 | `not publicly available` | [@agahkarakuzu](https://github.com/agahkarakuzu) | | [qmri_megre](https://github.com/bids-standard/bids-examples/tree/master/qmri_megre) | Multi-Echo Gradient-Echo for T2star mapping. | anat | MEGRE | `not publicly available` | [@agahkarakuzu](https://github.com/agahkarakuzu) | | [qmri_mese](https://github.com/bids-standard/bids-examples/tree/master/qmri_mese) | Multi-Echo Spin-Echo for T2 or Myelin Water Fraction (MWF) mapping. | anat | MESE | `not publicly available` | [@agahkarakuzu](https://github.com/agahkarakuzu) | -| [qmri_mp2rage](https://github.com/bids-standard/bids-examples/tree/master/qmri_mp2rage) | MP2RAGE for T1 mapping | anat | MP2RAGE, defacemask | [link](https://osf.io/k4bs5/) | [@Gilles86](https://github.com/Gilles86) | +| [qmri_mp2rage](https://github.com/bids-standard/bids-examples/tree/master/qmri_mp2rage) | MP2RAGE for T1 mapping | anat | MP2RAGE, T1map, UNIT1, defacemask | [link](https://osf.io/k4bs5/) | [@Gilles86](https://github.com/Gilles86) | | [qmri_mp2rageme](https://github.com/bids-standard/bids-examples/tree/master/qmri_mp2rageme) | Multi-echo MP2RAGE | anat, fmap | MP2RAGE, TB1map | [link](https://osf.io/k4bs5/) | [@Gilles86](https://github.com/Gilles86) | | [qmri_mpm](https://github.com/bids-standard/bids-examples/tree/master/qmri_mpm) | Multi-parametric mapping for R1, R2star, MTsat and PD mapping | anat, fmap | MPM, RB1COR, TB1EPI, magnitude1, magnitude2, phasediff | [link](https://osf.io/k4bs5/) | [@ChristophePhillips](https://github.com/ChristophePhillips) | | [qmri_mtsat](https://github.com/bids-standard/bids-examples/tree/master/qmri_mtsat) | Example dataset for T1 and MTsat mapping. Includes a double-angle B1+ mapping example. | anat, fmap | MTS, TB1DAM | [link](https://osf.io/k4bs5/) | [@agahkarakuzu](https://github.com/agahkarakuzu) | @@ -299,8 +301,8 @@ TABLE BELOW IS GENERATED AUTOMATICALLY. DO NOT EDIT DIRECTLY. --> -| name | description | datatypes | suffixes | link to full data | maintained by | -|:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------------------------|:-------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-------------------------------------------| -| [ds000117](https://github.com/bids-standard/bids-examples/tree/master/ds000117) | A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task | anat, beh, dwi, fmap, func, meg | T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans | [link](https://openneuro.org/datasets/ds000117/) | [@RikHenson](https://github.com/RikHenson) | -| [eeg_ds003645s_hed_demo](https://github.com/bids-standard/bids-examples/tree/master/eeg_ds003645s_hed_demo) | Shows usage of Hierarchical Event Descriptor (HED) in .tsv files | eeg, beh | channels, eeg, events, participants, scans | [link](https://openneuro.org/datasets/ds003645) | [@VisLab](https://github.com/VisLab) | -| [synthetic](https://github.com/bids-standard/bids-examples/tree/master/synthetic) | A synthetic dataset | anat, beh, func | T1w, beh, bold, events, physio, scans, sessions, stim | n/a | [@effigies](https://github.com/effigies) | \ No newline at end of file +| name | description | datatypes | suffixes | link to full data | maintained by | +|:------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------|:--------------------------------|:--------------------------------------------------------------------------------------------------------------------------|:-------------------------------------------------|:-------------------------------------------| +| [ds000117](https://github.com/bids-standard/bids-examples/tree/master/ds000117) | A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task | anat, beh, dwi, fmap, func, meg | FLASH, T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans | [link](https://openneuro.org/datasets/ds000117/) | [@RikHenson](https://github.com/RikHenson) | +| [eeg_ds003645s_hed_demo](https://github.com/bids-standard/bids-examples/tree/master/eeg_ds003645s_hed_demo) | Shows usage of Hierarchical Event Descriptor (HED) in .tsv files | anat, beh, eeg, micr, motion | KSSSleep, SPIM, beh, channels, coordsystem, defacemask, eeg, electrodes, events, headshape, motion, photo, samples, scans | [link](https://openneuro.org/datasets/ds003645) | [@VisLab](https://github.com/VisLab) | +| [synthetic](https://github.com/bids-standard/bids-examples/tree/master/synthetic) | A synthetic dataset | anat, beh, func | T1w, beh, bold, events, physio, scans, sessions, stim | n/a | [@effigies](https://github.com/effigies) | diff --git a/dataset_listing.tsv b/dataset_listing.tsv index 76b9fa11c..5bd1e3f53 100644 --- a/dataset_listing.tsv +++ b/dataset_listing.tsv @@ -2,7 +2,7 @@ name description link to full data maintained by datatypes suffixes eeg_matchingpennies Offline data of BCI experiment decoding left vs. right hand movement. BrainVision data format (.eeg, .vhdr, .vmrk) [link](https://doi.org/10.17605/OSF.IO/CJ2DR) [@sappelhoff](https://github.com/sappelhoff) eeg channels, eeg, events eeg_rishikesh Mind wandering experiment. EEG data in Biosemi (.bdf) format [link](https://openneuro.org/datasets/ds001787) [@arnodelorme](https://github.com/arnodelorme) eeg channels, eeg, events eeg_face13 Deconstructing the early visual electrocortical response to face and house stimuli. EDF format [@andesha](https://github.com/andesha) eeg channels, coordsystem, eeg, electrodes, events -eeg_ds003645s_hed_demo Shows usage of Hierarchical Event Descriptor (HED) in .tsv files [link](https://openneuro.org/datasets/ds003645) [@VisLab](https://github.com/VisLab) eeg, beh channels, eeg, events, participants, scans +eeg_ds003645s_hed_demo Shows usage of Hierarchical Event Descriptor (HED) in .tsv files [link](https://openneuro.org/datasets/ds003645) [@VisLab](https://github.com/VisLab) anat, beh, eeg, micr, motion KSSSleep, SPIM, beh, channels, coordsystem, defacemask, eeg, electrodes, events, headshape, motion, photo, samples, scans eeg_ds003645s_hed_library HED annotation using HED library vocabularies (schema). [link](https://openneuro.org/datasets/ds003645) [@VisLab](https://github.com/VisLab) eeg channels, eeg, events eeg_cbm Rest EEG. European Data Format (.edf) [@cpernet](https://github.com/cpernet) eeg channels, eeg, events, scans ieeg_filtered_speech recordings of three seizures [@choldgraf](https://github.com/choldgraf) ieeg channels, coordsystem, electrodes, events, ieeg, photo @@ -40,7 +40,7 @@ asl002 T1w, asl (Philips, PCASL, 2D_EPI), m0scan as separate scan [link](https:/ asl003 T1w, asl (Siemens, PASL, multiTI), M0scan as separate scan [link](https://osf.io/yru2q/) [@patsycle](https://github.com/patsycle) anat, perf T1w, asl, aslcontext, asllabeling, m0scan asl004 T1w, asl (Siemens, PCASL, multiPLD with pepolar), m0scan separate scans with pepolar approach [link](https://osf.io/yru2q/) [@patsycle](https://github.com/patsycle) anat, fmap, perf T1w, asl, aslcontext, asllabeling, m0scan asl005 T1w, asl (Siemens, PCASL, singleTI, 3D_GRASE), m0scan as separate scan [link](https://osf.io/yru2q/) [@patsycle](https://github.com/patsycle) anat, perf T1w, asl, aslcontext, asllabeling, m0scan -qmri_mp2rage MP2RAGE for T1 mapping [link](https://osf.io/k4bs5/) [@Gilles86](https://github.com/Gilles86) anat MP2RAGE, defacemask +qmri_mp2rage MP2RAGE for T1 mapping [link](https://osf.io/k4bs5/) [@Gilles86](https://github.com/Gilles86) anat MP2RAGE, T1map, UNIT1, defacemask qmri_mp2rageme Multi-echo MP2RAGE [link](https://osf.io/k4bs5/) [@Gilles86](https://github.com/Gilles86) anat, fmap MP2RAGE, TB1map qmri_mpm Multi-parametric mapping for R1, R2star, MTsat and PD mapping [link](https://osf.io/k4bs5/) [@ChristophePhillips](https://github.com/ChristophePhillips) anat, fmap MPM, RB1COR, TB1EPI, magnitude1, magnitude2, phasediff qmri_mtsat Example dataset for T1 and MTsat mapping. Includes a double-angle B1+ mapping example. [link](https://osf.io/k4bs5/) [@agahkarakuzu](https://github.com/agahkarakuzu) anat, fmap MTS, TB1DAM @@ -57,12 +57,12 @@ pet003 T1w, PET, blood [@mnoergaard](https://github.com/mnoergaard) anat, pet T pet004 PET, blood [@mnoergaard](https://github.com/mnoergaard) pet blood, pet pet005 T1w, PET [@mnoergaard](https://github.com/mnoergaard) anat, pet T1w, events, pet micr_SEM Example SEM dataset in PNG format with 1 sample imaged over 2 sessions [link](https://doi.org/10.5281/zenodo.5498378) [@jcohenadad](https://github.com/jcohenadad) micr SEM, photo, samples, sessions -micr_SEMzarr Example SEM dataset in PNG and OME-ZARR format with 1 sample imaged over 2 sessions [@TheChymera](https://github.com/TheChymera) micr SEM, samples, sessions +micr_SEMzarr Example SEM dataset in PNG and OME-ZARR format with 1 sample imaged over 2 sessions [@TheChymera](https://github.com/TheChymera) micr SEM, SPIM, samples, sessions micr_SPIM Example SPIM dataset in OME-TIFF format with 2 samples from the same subject with 4 chunks each [link](https://doi.org/10.5281/zenodo.5517223) [@jcohenadad](https://github.com/jcohenadad) micr SPIM, photo, samples fnirs_tapping Example fNIRS measurement with three conditions from five subjects [link](https://doi.org/10.5281/zenodo.5529797) [@rob_luke](https://github.com/rob_luke) nirs channels, coordsystem, events, nirs, optodes, scans fnirs_automaticity 24 subjects performing (non-)automatic finger tapping and foot stepping [link](https://doi.org/10.34973/vesb-mh30) [@robertoostenveld](https://github.com/robertoostenveld) nirs channels, coordsystem, events, nirs, optodes, practicelogbook, scans motion_systemvalidation Example dataset of two different motion captured system recorded almost simultaneously, but no brain data [link](https://doi.org/10.6084/m9.figshare.20238006.v2) [@JuliusWelzel](https://github.com/JuliusWelzel) motion channels, motion, scans -ds000117 A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task [link](https://openneuro.org/datasets/ds000117/) [@RikHenson](https://github.com/RikHenson) anat, beh, dwi, fmap, func, meg T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans +ds000117 A multi-subject, multi-modal human neuroimaging dataset of 19 subjects on a MEG visual task [link](https://openneuro.org/datasets/ds000117/) [@RikHenson](https://github.com/RikHenson) anat, beh, dwi, fmap, func, meg FLASH, T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans ds000246 Auditory dataset used for Brainstorm’s general online tutorial [link](https://openneuro.org/datasets/ds000246/versions/00001) [@guiomar](https://github.com/guiomar) anat, meg ChannelGroupSet, ClassFile, MarkerFile, T1w, channels, coordsystem, default, headshape, meg, params, photo, processing, scans ds000247 Five minutes, eyes-open, resting-state MEG data from 5 subjects. This is a sample from The Open MEG Archive (OMEGA). [link](https://openneuro.org/datasets/ds000247/versions/00001) [@guiomar](https://github.com/guiomar) anat, meg ClassFile, T1w, bad, channels, coordsystem, default, headshape, meg, params, processing, scans ds000248 MNE sample data: Data with visual and auditory stimuli [link](https://openneuro.org/datasets/ds000248/versions/00001) [@agramfort](https://github.com/agramfort) anat, meg FLASH, T1w, channels, coordsystem, events, meg, scans @@ -72,6 +72,6 @@ ieeg_epilepsy multiple sessions, tutorial [link](https://neuroimage.usc.edu/bst/ ieeg_epilepsyNWB multiple sessions, tutorial — derivative dataset of `ieeg_epilepsy` showcasing the NWB file format alternative [link](https://neuroimage.usc.edu/bst/getupdate.php?s=tutorial_epimap_bids) [@TheChymera](https://github.com/TheChymera) anat, ieeg T1w, channels, coordsystem, electrodes, events, ieeg, scans ieeg_epilepsy_ecog multiple sessions, tutorial [link](https://neuroimage.usc.edu/bst/getupdate.php?s=sample_ecog) [@ftadel](https://github.com/ftadel) anat, ieeg T1w, channels, coordsystem, electrodes, events, ieeg, photo, scans ieeg_visual_multimodal [@irisgroen](https://github.com/irisgroen) anat, fmap, func, ieeg T1w, bold, channels, coordsystem, electrodes, epi, events, ieeg, sbref -genetics_ukbb multiple tasks, T1w, DTI, BOLD, genetic info [@cpernet](https://github.com/cpernet) anat, dwi, fmap, func FLAIR, T1w, bold, dwi, events, info, magnitude1, phasediff +genetics_ukbb multiple tasks, T1w, DTI, BOLD, genetic info [@cpernet](https://github.com/cpernet) anat, dwi, func FLAIR, T1w, bold, dwi, events, info motion_dualtask older and younger participants walking while performing discrimination task [@sjeung](https://github.com/sjeung) eeg, motion channels, eeg, events, motion, scans motion_spotrotation participants rotated heading using full-body motion or joystick [link](https://openneuro.org/datasets/ds004460) [@sjeung](https://github.com/sjeung) eeg, motion channels, coordsystem, eeg, electrodes, events, motion, scans diff --git a/tools/print_dataset_listing.py b/tools/print_dataset_listing.py index 6644e247c..3d9b80141 100644 --- a/tools/print_dataset_listing.py +++ b/tools/print_dataset_listing.py @@ -1,5 +1,10 @@ """Take the listing of examples datasets -and turns it into a markdown document with a series of markdown tables.""" +and turns it into a markdown document with a series of markdown tables. + +You can pass an argument to insert the content in another file. +Otherwise the content will be added to the README of this repository. +""" +import sys from pathlib import Path import pandas as pd from bids import BIDSLayout @@ -22,7 +27,6 @@ root = Path(__file__).resolve().parent.parent input_file = root / "dataset_listing.tsv" -output_file = root / "README.md" tables_order = { "ASL": "perf", @@ -39,7 +43,14 @@ } -def main(): +def main(output_file=None): + + if len(sys.argv) > 1: + output_file = Path(sys.argv[1]) + + if output_file is None: + output_file = root / "README.md" + df = pd.read_csv(input_file, sep="\t") check_missing_folders(df, root)