From 37fbe4f9ce1eb2ba2284bd81b687b2bd8c4281a7 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 12 Nov 2025 09:58:33 -0500 Subject: [PATCH 1/2] Add about the need to bidsignore dandiset.yaml --- docs/user-guide-sharing/validating-files.md | 9 ++++++++- 1 file changed, 8 insertions(+), 1 deletion(-) diff --git a/docs/user-guide-sharing/validating-files.md b/docs/user-guide-sharing/validating-files.md index a118f961..53f23b65 100644 --- a/docs/user-guide-sharing/validating-files.md +++ b/docs/user-guide-sharing/validating-files.md @@ -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 `.bidsignore` file containing `dandiset.yaml`, since that DANDI-specific file is not part of BIDS specification; + - perform validation of the files ideally using both + - the stock [BIDS validator](https://bids.neuroimaging.io/tools/validator.html) + - 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. + +Note that [dandi upload](https://dandi.readthedocs.io/en/latest/cmdline/upload.html) will also perform validation during upload. From 7d922943788db23c3c777e5c4258d8678d10d6c7 Mon Sep 17 00:00:00 2001 From: Yaroslav Halchenko Date: Wed, 12 Nov 2025 12:33:04 -0500 Subject: [PATCH 2/2] Improve/fix wording/syntax Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- docs/user-guide-sharing/validating-files.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/docs/user-guide-sharing/validating-files.md b/docs/user-guide-sharing/validating-files.md index 53f23b65..61a07d28 100644 --- a/docs/user-guide-sharing/validating-files.md +++ b/docs/user-guide-sharing/validating-files.md @@ -47,9 +47,9 @@ Passing all of these levels of validation can sometimes be tricky. If you have a Once your files are converted to the BIDS standard, - - ensure that you have `.bidsignore` file containing `dandiset.yaml`, since that DANDI-specific file is not part of BIDS specification; + - 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/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. + - 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. Note that [dandi upload](https://dandi.readthedocs.io/en/latest/cmdline/upload.html) will also perform validation during upload.