Skip to content

Provide a summary statement at the end for papers to include #219

@yarikoptic

Description

@yarikoptic

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.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions