Merge pull request #460 from bids-standard/bfm

[ENH] allow to 'inject' example table on a comment rather a heading
bids-standard · Jul 31, 2024 · ad9db4b · ad9db4b
2 parents d2fe669 + fc84fd0
commit ad9db4b
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -113,6 +113,7 @@ file or open a
 and ask us directly.
 
 ## Dataset index
+<!-- ADD EXAMPLE LISTING HERE -->
 <!--
 TABLE BELOW IS GENERATED AUTOMATICALLY.
 DO NOT EDIT DIRECTLY.
@@ -256,7 +257,7 @@ DO NOT EDIT DIRECTLY.
 | name                                                                                                | description                                                             | datatypes   | suffixes                                                             | link to full data                              | maintained by                                            |
 |:----------------------------------------------------------------------------------------------------|:------------------------------------------------------------------------|:------------|:---------------------------------------------------------------------|:-----------------------------------------------|:---------------------------------------------------------|
 | [fnirs_automaticity](https://github.com/bids-standard/bids-examples/tree/master/fnirs_automaticity) | 24 subjects performing (non-)automatic finger tapping and foot stepping | nirs        | channels, coordsystem, events, nirs, optodes, practicelogbook, scans | [link](https://doi.org/10.34973/vesb-mh30)     | [@robertoostenveld](https://github.com/robertoostenveld) |
-| [fnirs_tapping](https://github.com/bids-standard/bids-examples/tree/master/fnirs_tapping)           | Example fNIRS measurement with three conditions from five subjects      | nirs        | channels, coordsystem, events, nirs, optodes, scans                  | [link](https://doi.org/10.5281/zenodo.5529797) | [@rob_luke](https://github.com/rob_luke)                 |
+| [fnirs_tapping](https://github.com/bids-standard/bids-examples/tree/master/fnirs_tapping)           | Example fNIRS measurement with three conditions from five subjects      | nirs        | channels, coordsystem, events, nirs, optodes, scans                  | [link](https://doi.org/10.5281/zenodo.5529797) | [@rob-luke](https://github.com/rob-luke)                 |
 
 ### PET
 

diff --git a/dataset_listing.tsv b/dataset_listing.tsv
@@ -59,7 +59,7 @@ pet005	T1w, PET		[@mnoergaard](https://github.com/mnoergaard)	anat, pet	T1w, eve
 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, 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_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	FLASH, T1w, beh, bold, channels, coordsystem, dwi, events, headshape, magnitude1, magnitude2, meg, phasediff, scans

diff --git a/tools/print_dataset_listing.py b/tools/print_dataset_listing.py
@@ -42,6 +42,7 @@
     "Behavioral": "beh",
 }
 
+DELIMITER = "<!-- ADD EXAMPLE LISTING HERE -->"
 
 def main(output_file=None):
 
@@ -123,7 +124,7 @@ def clean_previous_run(output_file: Path) -> None:
     lines = output_file.read_text().split("\n")
     with output_file.open("w") as f:
         for line in lines:
-            if line.startswith("## Dataset index"):
+            if line.startswith(DELIMITER):
                 f.write(line + "\n")
                 add_warning(f)
                 break