ebi-ait / checklist

Template repository for checklists
Apache License 2.0
1 stars 0 forks source link

checklist encoding errors #134

Open amnonkhen opened 1 month ago

amnonkhen commented 1 month ago

We need to update the checklists to avoid encoding errors produced by bad usage of certain special chars

An example of this can be seen in checklist ERC000022, on the "temperature" fields with the units; They used different chars for the "degree" character (º), which leads to errors when displaying validation errors.

A suggestion on how to improve this came from a meeting, to add checks on checklist generation

amnonkhen commented 2 weeks ago

Not sure if still relevant and if in scope for 1st prod version.

amnonkhen commented 2 weeks ago

The "temperature" fields in the mentioned checklist are:

  1. mean seasonal temperature - uses °C
  2. mean annual temperature - uses: ºC
  3. temperature - uses: ºC

Only the first one is the correct degree sign. The others use the "ordinal" sign. @Wkt8 is checking with Peter whether we should fix this.

Wkt8 commented 2 weeks ago

On reflection, I prefer the simplicity of MIxS’ YAML wordy approach although it looks less cool, is less error prone: “degree Celsius”. My preference would be to move all temperature to “degree Celsius” as the unit, then we continue to converge on the GSC MIxS standard where no good reason not to, which is our general strategy. (This continues to increase the interoperable nature of our metadata). Would do you all think?

Enrique pointed out that "degree Celsius" is also the Unit Ontology's preferred term . It might make sense to do this switch.

This would be two parts:

  1. Changing existing fields that use the special character to 'degree Celsius'
  2. Check that doesn't break data
Jeena-Rajan commented 2 weeks ago

Post production task as emulates current behaviour