Provide instructions for offline validation of BIDS datasets

[yarikoptic]

We have a BIDS dataset for which we have LOTS of HED errors and it is a large dataset so it takes long time to run bids-validator. We thought to just run hed validator directly. Got excited to see Javascript and Python versions listed on https://github.com/hed-standard/hed-examples/blob/develop/docs/source/HedValidationGuide.md but then got surprised that there seems to be no way to run hed validator directly locally without "online" or bids-validator. Is it possible? if so -- please add documentation.

Filed

• https://github.com/bids-standard/bids-validator/issues/2144

[VisLab]

Thanks for the suggestion. I'll make another pass on the docs.

We recommend that users validate the HED in their datasets before doing BIDS validation using the HED python validator. The validation of HED is can really be done independently of the rest of the BIDS and should be done separately. Use the Jupyter notebook validate_bids_dataset.ipynb which can be found in https://github.com/hed-standard/hed-examples/tree/main/src/jupyter_notebooks/bids to do this validation. If something in particular is giving you trouble -- post an issue so we can fix or use as an example in our guide.

The HED python validator has a complete implementation of HED validation. The JavaScript validator is behind -- we are working hard to catch it up --- but it doesn't quite handle validation of the special tags, particularly Delay and Duration yet. If your dataset passes the Python validation -- it should pass the validation in BIDS.

[yarikoptic]

notebooks are nice, but IMHO is a wrong level to interface it. Filed

• Add "hed-validator" to run validation on BIDS dataset hed-python#1025
  for your consideration!

edit: then it would be a matter of adding documentation to fully address this issue ;)