Skip to content

About the Schema

What is the Schema?

The BIDS schema is a machine readable representation of the BIDS Standard written in YAML. It is (by and large) the BIDS Specification, but written in a declarative form. For a full accounting of all methods, operators, and options provided to the user by the Schema we encourage you to look at the developer documentation contained within the source code here on GitHub.

The schema is split into three major divisions:

  • objects - Contains definitions of BIDS concepts and entities
  • rules - Rules for validation of file path names, file/folder contents (including sidecar and other metadata)
  • meta - Contains rules and definitions for the schema itself as well as defining a "context" object to which rules can be applied.

The schema is organized in the file structure in the tree seen below:

├── meta
│   └── context.yaml
├── objects
│   ├── columns.yaml
│   ├── ...
│   └── suffixes.yaml
├── rules
│   ├── checks
│   │   ├── asl.yaml
│   │   ├── ...
│   │   └── mri.yaml
│   ├── ...
│   └── suffixes.yaml

Where is the Schema?

The schema source code lives within the BIDS Specification; a deferenced JSON'ified verison can be found at the following url ->

Schema documentation

A full description of the schema can be found in the documentation for bidsschematools, the Python package developed to interact with the schema that is bundled with the specification.

History of the Schema

If you're just returning to BIDS, creating a new BEP, or simply curious as to the timeline and history of the transition from markdown to a yaml schema to render and use the BIDS Specification you are encouraged to browse the links below:

The schema began as a pull request to convert an entity table into a machine readable format and then began to grow in scope. Additional work towards the schematization of the specification has proceeded steadily (and in sometimes in bursts during Schema Sprints1, 2, 3) since.

Motivations and Goals

  • Machine readablity ensures interoperability with other tools and utilities
  • Uniform implementation between tools that use BIDS. Previously, other tools relied on their own data structures implemented from an interpretation of the specification.
  • Easier maintainance of the specification, tools, and other applications 1,5
  • Improve the process of writing BEPs

Extending the Schema and Validator

Past BIDS Extension Proposals (BEPs) have required extending the specification itself as well as the BIDS Validator. After rendering the BEP into markdown it was incumbent on the BEP leads or maintainers to then update the Validator with rules and logic to handle the new BEP. This double entry is a byproduct of the fact that the Validator was built in javascript to run both locally and from within the browser to validate BIDS data.

Efforts have been made to eliminate needing to implement a BEP in both a mark-up langugage and in javascript to satisfy the Validator. These two steps can be reduced into one by using the machine readable schema; one single input is then used for the specification, the Validator, or any other software or tool that interacts with BIDS. A change now made to a BEP, the spec in general, is now a change made and updated within the validator