bids-standard
Provide a summary statement at the end for papers to include
Steering committee is trying to facilitate markup of publications on BIDS datasets to state that paper covers a (valid) BIDS dataset. To that degree Aperture Neuro at https://apertureneuro.org/for-authors has now
For data documentation, it is advised to use the BIDS format (https://bids.neuroimaging.io/). It is recommended that the authors: 1) check the respective box in the submission form, 2) use ‘BIDS’ as one of the keywords of the manuscript, and 3) mention the version of the BIDS validator (e.g. this online tool) that was used to ensure BIDS compatibility. Reviewers are encouraged to check if data are indeed following the BIDS format.
But I think, in flavor of fmriprep providing an entire section, it would be great if bids-validator complemented its output of validator with a statement, such as
If describing this dataset in an article, please include: Dataset has passed BIDS validator x.y.z [zenodo ref] validating BIDS version X.Y.Z [zenodor ref] with A errors and B warnings . .bidsignore was present and ignored X out of Y files.
ideally it fetches the list of releases of BIDS and validator DOIs from zenodo and caches locally.
Hiiiii! I’d like to work on this.
To start, I can add a simple summary section at the end of the validator output, including:
validator version
BIDS schema version
number of errors and warnings
.bidsignore stats
I’ll begin with a small helper function to generate this text and then integrate it into the CLI output.
Sounds great! I would look into the --format json_pp output and verify this metadata is in the summary object, or else add it. I would then include this as part of the summary rendering.
