Skip to content

Commit 37fbe4f

Browse files
committed
Add about the need to bidsignore dandiset.yaml
1 parent 2352a69 commit 37fbe4f

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

docs/user-guide-sharing/validating-files.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -45,4 +45,11 @@ Passing all of these levels of validation can sometimes be tricky. If you have a
4545

4646
## Validating BIDS Files
4747

48-
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).
48+
Once your files are converted to the BIDS standard,
49+
50+
- ensure that you have `.bidsignore` file containing `dandiset.yaml`, since that DANDI-specific file is not part of BIDS specification;
51+
- perform validation of the files ideally using both
52+
- the stock [BIDS validator](https://bids.neuroimaging.io/tools/validator.html)
53+
- and/or [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.
54+
55+
Note that [dandi upload](https://dandi.readthedocs.io/en/latest/cmdline/upload.html) will also perform validation during upload.

0 commit comments

Comments
 (0)