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

Include the dataset_description.json as output #2

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

jhuguetn
Copy link

As per version 1.2.x BIDS specification states that a BIDS-compliant dataset MUST include the compulsory file dataset_description.json. See Section 03 (Modality agnostic files) of the BIDS specification.

This small PR ensures that the xnat2bids.py script copies the dataset_description.json JSON file stored in the BIDS resource into the output directory (if present).

The hereby proposed fix shall permit container-service using the xnat2bids setup-command to run up-to-date BIDS apps. Otherwise, BIDS apps might fail running due to invalid BIDS datasets, e.g. see error below running poldracklab/mriqc:0.15.1 container with current setting:

ValueError: 'dataset_description.json' is missing from project root. Every valid BIDS dataset must have this file.

For easy deployment, changes should be propagated in the creation of a new version of the xnat2bids-setup docker image at Docker Hub.

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.

1 participant