Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fNIRS example dataset (BEP030) #305

Merged
merged 7 commits into from
Sep 1, 2022

Conversation

rob-luke
Copy link
Member

@rob-luke rob-luke commented Jan 27, 2022

Dataset with functional near-infrared spectroscopy measurements in BIDS format.

Complete dataset (without zeroed data) can be found at https://github.com/rob-luke/BIDS-NIRS-Tapping

@rob-luke
Copy link
Member Author

FYI @rwblair

The tests are failing as the validator is not ready/merged yet.

Copy link
Member

@sappelhoff sappelhoff left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@rob-luke you can temporarily "switch on" fNIRS validation by changing this line in the CI workflow to use your validator branch:

git clone --depth 1 https://github.com/bids-standard/bids-validator

should be this then:

git clone --depth 1 https://github.com/rob-luke/bids-validator --branch nirs

(Also, it'd be good if you could update your branch to be in line with master, it's currently 99 commits behind :-) )

Before merging this PR (or when the validator PR is merged), we would then revert this change, so make sure to do this as an individual commit, so that later we can easily git revert it :-)

@rob-luke
Copy link
Member Author

Thanks @sappelhoff that seems to have worked. The master branch is now going green.

@sappelhoff sappelhoff changed the base branch from master to bep030_nirs June 14, 2022 07:17
@robertoostenveld
Copy link
Collaborator

@rob-luke should we also add the NIRS dataset that was prepared by @helenacockx to this pull request and the test?

@sappelhoff
Copy link
Member

@robertoostenveld I would prefer if you could add that in a separate PR to the bep030_nirs branch. But having another example would be great!

@rob-luke
Copy link
Member Author

should we also add the NIRS dataset that was prepared by @helenacockx

Thank you both very much!

@helenacockx
Copy link

helenacockx commented Jun 21, 2022

Thank you Robert for adding that example! I've recently found out that the 'type'-column for the optodes.tsv file was missing and the optode_layout was in the wrong folder. I will update that in the near future!

@robertoostenveld
Copy link
Collaborator

Thank you Robert for adding that example! I've recently found out that the 'type'-column for the optodes.tsv file was missing and the optode_layout was in the wrong folder. I will update that in the near future!

I have used the CHANGES file in my branch (see "files changed" and then "v1.1.3-emptyfiles") to document all json/tsv changes that were needed to get the data past the validator with the NIRS extensions that Rob has been working on. We can discuss these in detail later when you are back, and also apply them to the full dataset that you are about to share.

@rob-luke
Copy link
Member Author

to document all json/tsv changes that were needed to get the data past the validator with the NIRS extensions that Rob has been working on

Please be critical when incorporating feedback from the validator. The validator may have errors and/or the spec may be ambiguous. Now is the time to catch any of these small issues. Thanks for contributing a dataset here too.

@sappelhoff sappelhoff added this to the 1.8.0 milestone Jun 22, 2022
@sappelhoff sappelhoff marked this pull request as ready for review August 30, 2022 07:42
@sappelhoff sappelhoff merged commit 73839c5 into bids-standard:bep030_nirs Sep 1, 2022
@sappelhoff
Copy link
Member

Thanks @rob-luke

sappelhoff added a commit that referenced this pull request Sep 1, 2022
* fNIRS example dataset (BEP030) (#305)

* Add fNIRS example dataset

* Use nirs branch for validator

* Update fnirs_tapping/dataset_description.json

Co-authored-by: Stefan Appelhoff <[email protected]>

* Fix spacing in name

* revert link change validator

Co-authored-by: Stefan Appelhoff <[email protected]>

* [ENH] New fNIRS example dataset: (non-)auto finger/foot tapping (#323)

* added another example dataset for fNIRS, see #317

* use the nirs branch of the validator from rob-luke/bids-validator

* replaced "large" PDF file with a zero-byte version

* updated fNIRRS example dataset to pass the validator

 - fixed AnatomicalLandmarkCoordinateSy_t_em
 - fixed NIRSCoordinateUnit_e_s
 - removed txt from CHANGES
 - added stimulus MATLAB m-files to bidsignore
 - added sub-95 with n/a to practicelogbook.tsv
 - use n/a for empty cells in practicelogbook.tsv
 - added practicelogbook.tsv to bidsignore - HACK
 - removed sub-77 json files from sub-75/nirs directory
 - replaced 0-byte (empty) snirf files with 1-byte (still empty) snirf files - HACK
 - use forward slashes in scans.tsv
 - inserted "type" column in all optodes.tsv files
 - reordered the columns of channels.tsv

* renamed stim to stimuli

* added SourceType back to a JSON file where I accidentally deleted it

* revert validator branch change, add entry to README

Co-authored-by: Stefan Appelhoff <[email protected]>

Co-authored-by: Rob Luke <[email protected]>
Co-authored-by: Robert Oostenveld <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants