Skip to content

Commit

Permalink
Merge branch 'master' into master
Browse files Browse the repository at this point in the history
  • Loading branch information
melanieganz authored Aug 10, 2023
2 parents b49cf58 + bdc3d55 commit 5ac3791
Show file tree
Hide file tree
Showing 3 changed files with 22 additions and 0 deletions.
1 change: 1 addition & 0 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ nav:
- Glossary: glossary.md
- BIDS Extension Proposals: extensions.md
- Appendix:
- Schema: appendices/schema.md
- Contributors: appendices/contributors.md
- Licenses: appendices/licenses.md
- Entity table: appendices/entity-table.md
Expand Down
19 changes: 19 additions & 0 deletions src/appendices/schema.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
# BIDS schema

The BIDS schema is a machine readable representation of the BIDS standard,
written in a custom YAML format.
The goal of the schema is to provide a single source for rendering the specification
and validating BIDS datasets, reducing the scope for inconsistencies.
Third party tools may also use the schema to write code that will adapt to additions
to the BIDS standard.

The BIDS schema is available in two machine readable formats:

- as a set of [YAML](https://en.wikipedia.org/wiki/YAML) files in the [BIDS specification repository](https://github.com/bids-standard/bids-specification/src/schema)
- as a [single dereferenced json file](https://bids-specification.readthedocs.io/en/stable/schema.json)

A didactic walkthrough of the schema can be found in the [BEP Guide](https://bids-extensions.readthedocs.io/en/latest/schema/),
and a complete description is available in the [`bidsschematools` documentation](https://bidsschematools.readthedocs.io/en/latest/).
[`bidsschematools`](https://pypi.org/project/bidsschematools/) is a Python package sourced
from the specification repository, and includes the necessary code to render the specification
and filename validation.
2 changes: 2 additions & 0 deletions src/schema/objects/metadata.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -500,6 +500,8 @@ ContrastBolusIngredient:
- CARBON DIOXIDE
- BARIUM
- XENON
- UNKNOWN
- NONE
DCOffsetCorrection:
name: DCOffsetCorrection
display_name: DC Offset Correction
Expand Down

0 comments on commit 5ac3791

Please sign in to comment.