GenomicsStandardsConsortium / mixs

Minimum Information about any (X) Sequence” (MIxS) specification
https://w3id.org/mixs
Creative Commons Zero v1.0 Universal
36 stars 21 forks source link

"or {text}" Value syntaxes make no sense #452

Open turbomam opened 2 years ago

turbomam commented 2 years ago

Value syntaxes are provided for machine validation.

"{something specific} or {text}" is equivalent to "{text}". The {something specific} applies no constraints to the Value syntax. Guidance like that should be put in another attribute of the MIxS term.

Value syntax Example Requirement Preferred unit Occurrence MIXS ID
[active surveillance in response to an outbreak|active surveillance not initiated by an outbreak|clinical trial|cluster investigation|environmental assessment|farm sample|field trial|for cause|industry internal investigation|market sample|passive surveillance|population based studies|research|research and development] or {text} field trial M   1 MIXS:0001151
turbomam commented 2 years ago

While the terms contributed by package submitters are vital to MIxS and very much appreciated, more discipline is required in the Value syntax and Example columns.

See esp. 'host scientific name' from the agriculture package

Environmental package Structured comment name Package item Definition Expected value Value syntax Example Requirement Preferred unit Occurrence MIXS ID github ticket                                          
agriculture specific_host host scientific name Report the host's taxonomic name and/or NCBI taxonomy ID. host scientific name, taxonomy ID {text}|{NCBI taxid} Homo sapiens and/or 9606 M   1 MIXS:0000029