inbo / checklist

An R package for checking R packages and R code
https://inbo.github.io/checklist
GNU General Public License v3.0
16 stars 2 forks source link

Title case is not recommended in bibliographic records #111

Closed florisvdh closed 1 year ago

florisvdh commented 1 year ago

See discussion in https://docs.citationstyles.org/en/stable/specification.html#text-case:

CSL processors don’t recognize proper nouns. As a result, strings in sentence case can be accurately converted to title case, but not vice versa. For this reason, it is generally preferable to store strings such as titles in sentence case

Since title case is required in the DESCRIPTION title :thinking: , I see no obvious solution though (some words must remain capitalized, e.g. 'R'), but having title case copied everywhere is a suboptimal situation.

florisvdh commented 1 year ago

I presume the only solution here would be to not regard the DESCRIPTION title as the source, but request the user to type the title as sentence case and perhaps store that in the checklist.yml file. Then, derive a Title Case title for DESCRIPTION (e.g. as part of tidy_desc()) and recycle the sentence case title elsewhere.

ThierryO commented 1 year ago

We see DESCRIPTION of the central source of all the metadata. This is why we moved the keywords and Zenodo community from the checklist.yml to DESCRIPTION. Sticking to the R requirements and keeping things simple is IMHO more important than have sentence case in the citation information.