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

ENH: Add qMRI example datasets #245

Merged
merged 17 commits into from
Feb 15, 2021
Merged

Conversation

guiomar and others added 8 commits February 4, 2021 09:19
* Update CHANGES

* Update dataset_description.json

* Update README

* Update sub-emptyroom_task-noise_run-01_meg.json
* Update CHANGES

* Update dataset_description.json

* Update README

* Update sub-0002_ses-0001_task-rest_run-01_meg.json

* Update sub-0003_ses-0001_task-rest_run-01_meg.json

* Update sub-0004_ses-0001_task-rest_run-01_meg.json

* Update sub-0006_ses-0001_task-rest_run-01_meg.json

* Update sub-0007_ses-0001_task-rest_run-01_meg.json

* Update sub-emptyroom_ses-18901014_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18901015_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18910228_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18910303_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18910512_task-noise_run-01_meg.json
* validate headers in synthetic ds

* fix str

* put if-else into right nesting

* beautysh code formatting
@effigies
Copy link
Contributor Author

effigies commented Feb 9, 2021

Getting errors about fmap/*_TB1map.nii. Should these be moved to anat/ or should the spec be updated to put them in fmap/?

cc @agahkarakuzu @tsalo (please cc anybody else who should be added)

@tsalo
Copy link
Member

tsalo commented Feb 9, 2021

They should be under fmap (see here), but I missed them in https://github.com/bids-standard/bids-validator/pull/1161. 🤦

I can open a PR to the validator to fix that oversight.

EDIT: I've opened bids-standard/bids-validator#1183.

@effigies
Copy link
Contributor Author

@tsalo To be clear, I meant TB1Map/RB1Map (schema). Those are declared in anatomical.

@effigies
Copy link
Contributor Author

Nice catches, @sappelhoff. I think we're down to

"FlipAngle": 65,
"MTState": false,
"NumberShots": 11,
"TotalReadoutTime": 6720.006240000001,
Copy link
Member

@sappelhoff sappelhoff Feb 13, 2021

Choose a reason for hiding this comment

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

We are getting a warning for the TotalReadoutTime fields in the qmri_mpm datasets:

Seems valid:

image

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.

we also get warnings about missing Author fields. I inquired with the BEP001 team how to resolve this: https://mattermost.brainhack.org/brainhack/pl/icwy7hqqwtnjzjrzpmmgmehgby

Probably adding something like ["qmri BEP Team", "BIDS maintainers"] will be fine.

@Gilles86
Copy link

@sappelhoff ,

The MP2RAGE and MP2RAGE-ME datasets are authored by myself and Tomas Knapen.

For the MPM I think you should check with @ChristophePhillips and @lazaral

I think the rest has been provided by @agahkarakuzu

@agahkarakuzu
Copy link
Contributor

@sappelhoff I noticed that the validator was complaining about single authorship :) I started expanding the example datasets and validator, I can edit them as I go by preserving 1st dataset providers' order.

@sappelhoff
Copy link
Member

Thanks both, I think it'd be best if you could update the OSF datasets with the authors, and mirror the changes that @effigies already did (see e.g., 7e1ec55 and 8d6f42d) --> Then Chris can pull these changes into his datalad controlled datasets, and then push them to bids-examples.

Perhaps you can also solve #245 (comment) as you go

as for validator, please see: https://github.com/bids-standard/bids-validator/pull/1186

from that PR, the validator now passes for qMRI.

@lazaral
Copy link

lazaral commented Feb 13, 2021

@sappelhoff, regarding the MPM dataset, we used the one from this publication: https://www.sciencedirect.com/science/article/pii/S235234091930486X?via%3Dihub

We currently have the first author of that manuscript names as author of the dataset in the OSF repo. Should we add the full author list to the dataset_description.json?

@sappelhoff
Copy link
Member

Should we add the full author list to the dataset_description.json?

@lazaral yes please, make it an array of strings: ["author1", "author2", ...]

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.

All datasets are passing bids-validator when validating using the changes from https://github.com/bids-standard/bids-validator/pull/1186

As I mention in https://github.com/bids-standard/bids-validator/pull/1186#issuecomment-779333369, I suggest to merge this PR into the https://github.com/bids-standard/bids-examples/tree/bep001_qmri branch.

Then we can sort out the final issues and them merge that one into master

@sappelhoff sappelhoff changed the base branch from master to bep001_qmri February 15, 2021 16:39
@sappelhoff sappelhoff merged commit 2806946 into bids-standard:bep001_qmri Feb 15, 2021
sappelhoff added a commit that referenced this pull request Feb 24, 2021
* ENH: Add qMRI example datasets (#245)

* Minor metadata changes  (#231)

* Update CHANGES

* Update dataset_description.json

* Update README

* Update sub-emptyroom_task-noise_run-01_meg.json

* Fix coordinate systems (#238)

* Fix coordinates (#239)

* Minor updates for ds000247 (#232)

* Update CHANGES

* Update dataset_description.json

* Update README

* Update sub-0002_ses-0001_task-rest_run-01_meg.json

* Update sub-0003_ses-0001_task-rest_run-01_meg.json

* Update sub-0004_ses-0001_task-rest_run-01_meg.json

* Update sub-0006_ses-0001_task-rest_run-01_meg.json

* Update sub-0007_ses-0001_task-rest_run-01_meg.json

* Update sub-emptyroom_ses-18901014_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18901015_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18910228_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18910303_task-noise_run-01_meg.json

* Update sub-emptyroom_ses-18910512_task-noise_run-01_meg.json

* validate headers in synthetic ds (#240)

* validate headers in synthetic ds

* fix str

* put if-else into right nesting

* beautysh code formatting

* run tests on all platforms (#241)

* ENH: Add qMRI example datasets

* Add READMEs

* Authors -> list

* Duplicate EchoTime for phasediff, IntendedFor NIfTIs

* Authors -> list

* Add mt entity to T1w file, MTState to all MTS metadata

* qmri_mpm: fix IntendedFor targets

* Use EchoTime2 in normal diff range

* add qmri ds to README index

* pull test script out of gh ci, into own script for local usage

* Add flip and inv entities to TB1SRGE

Co-authored-by: Julia Guiomar Niso Galán <guiomar.niso@ctb.upm.es>
Co-authored-by: Francois <francois.tadel@mcgill.ca>
Co-authored-by: Stefan Appelhoff <stefan.appelhoff@mailbox.org>

* Add tb1_afi

* Add IRT1 and move B1AFI from root-->VFA

* Rm tb1afi from root

* Add MESE 32 echoes

- Monoexponential T2 mapping (T2map and M0map)
- Myelin water fraction (MWFmap only)

* Add MTRmap and TB1DAM @mts

- Fix MTS metadata

* QSM - An example method

- Add example input

* Change dataset type

* Add MEGRE

* Add TB1TFL

* rm B1map from IRT1 dir

* rm leftover MESE

* Fix SA2RAGE

* Fix IRT1

* Metadata and authors

* Update Readme

* CI errors

* Update qmri_qsm/derivatives/qMRLab/sub-01/dataset_description.json

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update qmri_sa2rage/sub-01/fmap/sub-01_flip-1_inv-1_TB1SRGE.json

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* fix typos

* drop intended for from anats

* drop intended for from anat

* drop intended for from anat

* Update readme and fix a single json

* Fixes around intended for

* mv fmap into the right dir

* Update qmri_mtsat/sub-01/fmap/sub-01_flip-1_TB1DAM.json

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

* Update qmri_mtsat/sub-01/fmap/sub-01_flip-2_TB1DAM.json

Co-authored-by: Chris Markiewicz <effigies@gmail.com>

Co-authored-by: Chris Markiewicz <markiewicz@stanford.edu>
Co-authored-by: Julia Guiomar Niso Galán <guiomar.niso@ctb.upm.es>
Co-authored-by: Francois <francois.tadel@mcgill.ca>
Co-authored-by: Agah Karakuzu <agahkarakuzu@gmail.com>
Co-authored-by: Chris Markiewicz <effigies@gmail.com>
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.

8 participants