Skip to content
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.

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

Make capitalization of suffixes consistent #26

Open
tsalo opened this issue Aug 3, 2020 · 9 comments
Open

Make capitalization of suffixes consistent #26

tsalo opened this issue Aug 3, 2020 · 9 comments
Labels
suffixes Changes to suffixes.

Comments

@tsalo
Copy link
Member

tsalo commented Aug 3, 2020

See: https://groups.google.com/forum/?utm_medium=email&utm_source=footer#!msg/bids-discussion/yOYaLNTh-_A/rPLd3JpsAgAJ

I see 3 possible routes

  1. not care about capitalization (ie accept bold and BOLD)
  2. not capitalize and keep the standard consistency
  3. have a mix, no specific rationale with "old" suffixes and "NEW" ones

I must say 2 and 3 seem at first sight preferable to 1 - but I would probably go for 2 if there are no strong rationale for 3 (which there may be)

Original authors: @jbpoline

@tsalo
Copy link
Member Author

tsalo commented Aug 3, 2020

@jcolomb wrote:

I have just spent 6 hours to debug an application developed on windows but that should run on linux because of a capitalisation problem: my 2 cents: do not accept any capital letter.

@tsalo tsalo added the suffixes Changes to suffixes. label Aug 3, 2020
@jbteves
Copy link

jbteves commented Aug 4, 2020

I am in favor of route (2).

@yarikoptic
Copy link
Contributor

@tsalo would it then also cover entity's values?
or those should be fine as long as they are not coming from controlled (in BIDS) vocab (like _task-rest)

I am asking because not sure how Windows would behave if there was e.g. _task-one and _task-One -- would it be different/the same name? I think we in DataLad and git in general had similar gotchas , e.g. https://www.hanselman.com/blog/git-is-casesensitive-and-your-filesystem-may-not-be-weird-folder-merging-on-windows .

@tsalo
Copy link
Member Author

tsalo commented Feb 28, 2024

I don't particularly want to restrict freeform values (i.e., the label pattern for certain entities), but I can see why having case-insensitive unique values would be a good restriction. I personally want to adopt a single convention for suffixes, since some are currently capitalized, while others are not.

I should clarify, though, that the original proposal was @jbpoline's. I just copied it over from the old BIDS 2.0 Google Doc. Though I do support it, in the form of JB's option 2.

@Lestropie
Copy link

This came to mind recently, particularly thinking about bids-standard/bids-specification#1862 and bids-standard/bids-specification#1831.

My initial instinct before coming across this existing Issue was that capitalisation could apply exclusively to:

  • Acronyms
  • Established mathematical symbols (eg. "T1")

This would arguably then extend beyond suffices to directory names also; eg. sub-01/anat/, sub-01/DWI/, sub-01/func/.

Not 100% sold on the idea, but considered it worthwhile listing.

@CPernet
Copy link

CPernet commented Jun 28, 2024

oh boy stop pointing out at inconsistency here .. @yarikoptic s' baby for BIDS 2.0 lol

@CPernet
Copy link

CPernet commented Jun 28, 2024

should we here just lower case all 4 cases?

@Lestropie
Copy link

should we here just lower case all 4 cases?

I think from this comment you may have erroneously associated my comment here with the ongoing discussion around DWI scanner-generated derivatives on BIDS 1.x. It is however intentionally associated with BIDS 2.0 discussion. What to do about capitalisation of specifically DWI scanner-generated derivatives in 1.x would be better placed at bids-standard/bids-specification#1864.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
suffixes Changes to suffixes.
Projects
None yet
Development

No branches or pull requests

5 participants