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

DRAFT: New Principle 19 - for OBO Operations Review #2668

Draft
wants to merge 10 commits into
base: master
Choose a base branch
from

Conversation

nataled
Copy link
Contributor

@nataled nataled commented Jan 14, 2025

No description provided.

@nataled nataled added attn: Operations Committee Issues pertinent to broad Foundry activities, such as policies and guidelines principles Issues related to Foundry principles labels Jan 14, 2025
@nataled nataled self-assigned this Jan 14, 2025
is_obsolete: true
replaced_by: OBI:0001544
```
For OBO format, there are multiple alternatives:
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't think this has anything directly to do with OBO format. GO, Uberon, CL, all phenotype ontologies all use the same simple data model e.g. making use of comments because this is what browsers show more prominently, because it's simpler and more consistent. Nothing to do with format. OBO Format can represent annotation assertions at exactly the same level of expressivity as OWL

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

These alternatives are listed for OBO format because they are used 'in the field' so to speak. That is, unlike ontologies in OWL format--which all seem to use the same deprecation methods--OBO formatted ontologies have been using different means. I've confirmed that either way is fine, so we say all this to acknowledge these alternatives.

[Typedef]
id: has_obsolescence_reason
name: has obsolescence reason
xref: IAO:0000233
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

wrong ID

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Oops, thanks! Fixed.

The OBO Dashboard will show:
- An ERROR if any obsolete term (that is, a term with an "owl:deprecated" property or "is_obsolete: true" tag) does not also have 'obsolete ' (that exact string, lowercase and space included, with no other punctuation) prepended to the label
- An ERROR if any obsolete term (as indicated by term label or definition) lacks an "owl:deprecated" property or "is_obsolete: true" tag
- An ERROR if an obsolete term has any associated logical axioms (including any subClassOf/is_a declarations)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

is "associated with" the same as "referencing"?

(best to use precise terms, we generally follow the owlapi vocabulary e.g "about" "referencing")

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yes, that's half the intent. Revising.


The PRO term "phosphoprotein" (PR:000037070) is defined as "A protein that includes at least one phosphorylated residue." A study finds 2000 more examples than was previously known. In this case, no new term needs to be made (nor the original deleted) because (1) the term definition did not change; and (2) the referent--proteins with a phophoresidue--did not change (that is, the newly-discovered phosphoproteins are just additional examples of that referent).

Criteria for review
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

presumably this is criteria for dashboard review?

The earlier text lays out criteria about definitions changing in meaning. This could easily be checked by LLM using KGCL, but the dashboard doesn't support this yet

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The heading 'Criteria for review' intends to capture all possible types of review. Here we list what we can reasonably check. If the future adds more powerful checks, those checks will be added.

Implementation
-------

Detailed procedures for obsoleting a term are described on the OBO Academy page [Obsoleting an Existing Ontology Term](https://oboacademy.github.io/obook/howto/obsolete-term/).
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See also kgcl:NodeObsoletion for a taxonomy of kinds of obsoletion

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@cmungall So far as I can tell, IAO has basically the same set of reasons. The benefit to mentioning this other resource is unclear.

Copy link
Contributor

@cmungall cmungall left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

See comments, some minor. Overall I recommend not mixing up orthogonal file syntax issues with OMO profiles

Copy link
Contributor

@matentzn matentzn left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I like this principle very much; some general feedback:

  1. the principle is about "term stability", yet the focus is entirely about definitions (IAO:0000115). I think the principle text should clearly refer to all ways a meaning can significantly change, including in cases where there is no human readable definition, but a rich axiomatic structure (like say in PRO or CHEBI).
  2. I like the concept of "referents" very much; but what I am missing here is that the source of the mapping between and ID and its referent is solely in the head of the ontology developer. So I would like the text to reflect the idea of "as intended by the ontology developer". I think this is important because the referents are never explicit, and we need to have a source of truth for who gets to define these somewhere in the text. This also helps with deciding "if the referent changed or not" - as you say, only the ontology author can decide this.

Addresses Chris M's suggestions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
attn: Operations Committee Issues pertinent to broad Foundry activities, such as policies and guidelines principles Issues related to Foundry principles
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants