bids: needs knowledge about how to validate against BEP

[yarikoptic]

ATM it largely misguides, as for the question

how to use bids-validator on a dataset against some perspective BEP which modified the schema

the answer was:

I'll help you understand how to validate a dataset against a BIDS Extension Proposal (BEP) that modifies the schema. Let me first fetch the validator documentation to give you accurate guidance.The standard validator documentation doesn't directly address BEP validation. Let me search for discussions about this specific use case.Excellent! There's a directly relevant issue. Let me get more details on that first issue about testing against custom specifications.Based on my research, here's what you need to know about validating against a BEP schema:

Current Status

The standard BIDS validator does not yet have built-in support for validating against custom or BEP schemas. There's an open feature request for this: Issue #121 in bids-validator requesting the ability to test against custom bids-specification and bids-examples PRs.

Workarounds for BEP Validation

1. Validate Against the BEP's PR Branch (Recommended)

If the BEP has an open PR in the bids-specification repository:

• Clone the PR branch locally
• Build the validator from that branch
• Run validation against your dataset

git clone https://github.com/bids-standard/bids-validator.git
cd bids-validator
# Check out the branch with BEP schema changes if available
git checkout <bep-branch>
npm install
npm run build
./bin/bids-validator /path/to/your/dataset

2. Manual Schema Validation

• Download the modified schema from the BEP PR
• Validate your dataset's filenames and metadata against the schema rules manually
• Check the BEP documentation for specific requirements

3. Use the Specification Preview

Most BEP PRs have a ReadTheDocs preview. Review the modified specification directly and ensure your data complies with the documented changes.

Next Steps

• Which BEP are you working with? I can look up its current status and PR details
• Do you have a specific validation error? Share it and I can help troubleshoot
• Consider opening a discussion on NeuroStars about your specific BEP validation needs

So it needs knowledge, which we should also replicate I guess across existing documentation since I think we lack it there too, that

• although it is correct that there might be a BEP branch, it is not necessarily the case and it might be that changes to schema are the only thing
• for changes in schema, it is enough to install bids-validator and point to the schema for that BEP (via --schema or BIDS_SCHEMA env var) either from collection on https://github.com/bids-standard/bids-schema/tree/main/BEPs#readme or (likely preferable) directly from the BEP PR website rendering preview. E.g. for [ENH] BEP047 - Add audio/video recordings to behavioral experiments bids-standard/bids-specification#2231 it would be https://bids-specification--2231.org.readthedocs.build/en/2231/schema.json and thus invocation would be like bids-validator --schema https://bids-specification--2231.org.readthedocs.build/en/2231/schema.json [FURTHER OPTIONS/ARGS]

[neuromechanist]

100%

Thanks @Yarik, I don't know that either. Every time, I have to make some deduction to work that out. Probably it is best to add it to BIDS documentation, then OSA will naturally pick it up?