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

[ENH] add schema in appendix #1543

Merged
merged 3 commits into from
Aug 10, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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.