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

Adding rules for instance PRs for controlledTerms #10

Open
lzehl opened this issue Nov 27, 2023 · 1 comment
Open

Adding rules for instance PRs for controlledTerms #10

lzehl opened this issue Nov 27, 2023 · 1 comment

Comments

@lzehl
Copy link
Member

lzehl commented Nov 27, 2023

  • we should always provide: name + (short) definition
  • definition should be one sentence (not repeating the name or listing synonyms, e.g.
    • name: "hertz"
    • definition: "Unit of frequency in the International System of Units (SI), equivalent to one event (or cycle) per second"
  • if definition (or description) is taken from somewhere else cite the source (with hyperlink where possible)
    • if full copy: ".... [XXX]."
    • if adapted: ".... . [adapted from XXX]
  • synonyms should only list exact synonyms (we need to discuss if we want to list abbreviations separately)
  • @id suffix should be written in ".../lowerCamelCase" except the term is an actual name or abbreviation that is always capitalized
  • interlexIdentifier is repeated under preferredOntologyIdentifier when InterLex defined the ontology (longterm for next version: change preferredOntologyIdentifier to ontologyIdentifier with list value 1-N)

@openMetadataInitiative/openminds-developers anything missing for controlledTerms ?

@lzehl
Copy link
Member Author

lzehl commented Jan 29, 2024

specific rules/guidelines:

licenses:

  • shortName = SPDX short name
  • atID prefix = shortname
  • filename = atID prefix
  • fullName = SPDX full name
  • SPDX is preferred external source
  • legal code is preferred to link to the license agreement text (not always possible)

contentTypes:

  • name = IANA.org media type naming convention
  • atID prefix = name with "/" replaced with "_"
  • filename = atID prefix
  • a short description is desirable (especially for custom content types)
  • relatedMediaType = ??? (parent media type? OR matching media type?)

molecularEntities:

  • name = PubChem (if possible)
  • preferredOntologyIdentifier = CHEBI (if possible)

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

No branches or pull requests

1 participant