because BIDS : Disallow hyphens & underscores in VisitLabels etc.

[christinerogers]

This issue (a) needs clarification in our docs
and (b) should get verified that it's well covered in our codebase - wherever the relevant variables are defined/created or loaded/validated

Because underscores and hyphens are delimiters in BIDS file paths, any variables in LORIS used in BIDS filepaths shouldn't contain them either, as we move increasingly into BIDS for more modalities.

This applies to anything in the BIDS path:

• PSCID : subject_id or candidate
• visit label
• scan type and possibly more?

Comments on slack from cecile:

the `-` and `_` have meanings in BIDS, therefore they cannot be used in candidate ID, visit labels, scan type and so on
the `_` separates the different part of the file name and the `-` is used to separate the identifier from the value:
aka sub-<candidate>_ses-<visit>_<blablabla>.edf

Possible alternatives ? Develop a way of mapping visit labels, e.g. using another delimiter.

caught by @maltheism

[christinerogers]

include some recommendations:

• safe delimiters ? --> any other characters we can recommend to use ?
• recommend camel case ?

[christinerogers]

@cmadjar any idea where to put this? it probably be easier to put this under the Visit labels troubleshooting guide or Readme ?

[cmadjar]

@christinerogers maybe both so the user cannot miss it? Or in the Readme add a link to the visit label guidelines?

[christinerogers]

@cmadjar sounds good - i'll self-assign and see if we can get this done simply during the release process.

[christinerogers]

this is still legit .