Skip to content

Add about the need to bidsignore dandiset.yaml #215

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.

Sign up for GitHub

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

Open
yarikoptic wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add about the need to bidsignore dandiset.yaml #215

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
37fbe4f
Add about the need to bidsignore dandiset.yaml
yarikoptic Nov 12, 2025
7d92294
Improve/fix wording/syntax
yarikoptic Nov 12, 2025
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
9 changes: 8 additions & 1 deletion docs/user-guide-sharing/validating-files.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -45,4 +45,11 @@ Passing all of these levels of validation can sometimes be tricky. If you have a

## Validating BIDS Files

Once your files are converted to the BIDS standard, perform validation of the files using the [BIDS validator](https://bids.neuroimaging.io/tools/validator.html).
Once your files are converted to the BIDS standard,

- ensure that you have a `.bidsignore` file containing `dandiset.yaml`, since that DANDI-specific file is not part of the BIDS specification;
- perform validation of the files ideally using both
- the stock [BIDS validator](https://bids.neuroimaging.io/tools/validator.html)
- and [dandi validate](https://dandi.readthedocs.io/en/latest/cmdline/validate.html) since it would also validate using other helper tools such as [NWB inspector](https://nwb.org/tools/core/nwbinspector/) if you have NWBs, to ensure that your data is compliant to all used standards.
Comment on lines +51 to +53
Copy link
Member

@kabilar kabilar Nov 12, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Suggested change
- perform validation of the files ideally using both
- the stock [BIDS validator](https://bids.neuroimaging.io/tools/validator.html)
- and [dandi validate](https://dandi.readthedocs.io/en/latest/cmdline/validate.html) since it would also validate using other helper tools such as [NWB inspector](https://nwb.org/tools/core/nwbinspector/) if you have NWBs, to ensure that your data is compliant to all used standards.
- perform validation of the files using [dandi validate](https://dandi.readthedocs.io/en/latest/cmdline/validate.html) to ensure your data is compliant with the BIDS and/or NWB standards. Alternatively, you could independently validate your files using the [BIDS Validator](https://bids.neuroimaging.io/tools/validator.html) and/or [NWB Inspector](https://nwb.org/tools/core/nwbinspector/).


Note that [dandi upload](https://dandi.readthedocs.io/en/latest/cmdline/upload.html) will also perform validation during upload.