Add a hint to add dandiset.yaml into .bidsignore while working on bids dandiset

[yarikoptic]

dandiset.yaml is not legit in the scheme of BIDS. We need to explicitly ignore it for bids-validator to function without issuing a WARNING or an ERROR. So while validating BIDS Dandiset - issue such a hint.

More on general .bidsignore format etc:

• Standardize .bidsignore bids-standard/bids-specification#131 (comment)

[candleindark]

It seems to me that your intent is to ensure the user submit a BIDS dandiset that is fully BIDS compliant by specifying a .bidsignore file that allows the dandiset.yaml file by informing the user about the needed specification in the .bidsignore file should that be missing. In #1599, I used

dandi-cli/dandi/files/bids.py

Lines 26 to 31 in b697445

	BIDS_VALIDATOR_CONFIG = {
	"ignore": [
	# Ignore any error regarding the dandiset metadata file
	{"location": f"/{dandiset_metadata_file}"}
	]
	}

to have the BIDS validator completely suppress the error regarding the dandiset.yaml file. If I take that configuration out, running dandi validate against a BIDS dandiset would produce the following error (with the severity of ERROR).

[BIDS.NOT_INCLUDED] /Users/isaac/Developer/Dartmouth/workshop/bids-error-examples/invalid_asl003/dandiset.yaml — Files with such naming scheme are not part of BIDS specification. This error is most commonly caused by typos in file names that make them not BIDS compatible. Please consult the specification and make sure your files are named correctly. If this is not a file naming issue (for example when including files not yet covered by the BIDS specification) you should include a ".bidsignore" file in your dataset (see https://github.com/bids-standard/bids-validator#bidsignore for details). Please note that derived (processed) data should be placed in /derivatives folder and source data (such as DICOMS or behavioural logs in proprietary formats) should be placed in the /sourcedata folder.

I think this error (or error message) is very informative, and taking out the configuration that suppresses it alone will achieve your intent. Of course, I can modify the message to give it some context of Dandi if you think that is better. However, I would advise against changing this message so that it has a severity of Severity.HINT or having the presence of dandiset.yaml be handled by logic that's separate from the BIDS validator because it is indeed a validation error per the BIDS standard.

[yarikoptic]

• yeah, let's stop "ignoring" and make it all proper BIDS
• I think it would indeed be nice to adjust the message for dandiset.yaml specifically

[candleindark]

• yeah, let's stop "ignoring" and make it all proper BIDS
• I think it would indeed be nice to adjust the message for dandiset.yaml specifically

These changes are now part of #1599, and it closes this issue.

[github-actions]

🚀 Issue was released in 0.69.0 🚀