ontology icon indicating copy to clipboard operation
ontology copied to clipboard

reconsidering the usage of term tracker item

Open stap-m opened this issue 1 year ago • 4 comments

Description of the issue

This comes from https://github.com/information-artifact-ontology/ontology-metadata/issues/175

We discussed this in the last oeo-dev meeting:

  • IAO proposal: tighten range of IAO:0000223 to URL
  • In future, only URLs are allowed, not comments, strings etc

Ideas of solution

  • think of a solution how we deal with that:
    • only link to issue or PR
    • add several term tracker items (issues/PRs) for discussion history
  • Update IAO import once the changes are released
  • apply solution to existing entities, i.e. write a script
  • document in wiki

Workflow checklist

  • [ ] I discussed the issue with someone else than me before working on a solution
  • [ ] I already read the latest version of the workflow for this repository
  • [ ] The goal of this ontology is clear to me

I am aware that

  • [ ] every entry in the ontology should have a definition
  • [ ] classes should arise from concepts rather than from words

stap-m avatar May 03 '24 07:05 stap-m

Other option: define our own term tracker item and replace IAO:0000223 with our own.

l-emele avatar May 06 '24 07:05 l-emele

Other option: define our own term tracker item and replace IAO:0000223 with our own.

Sure. Maybe we can even combine our own annotation and the proper usage of IAO:0000223. Topic for next dev meeting❗

Just as an example, this is how IAO document the devolopment history:

grafik

stap-m avatar May 07 '24 09:05 stap-m

From latest oeo-dev 79:

  • discussion:
    • only URLs as range and no longer plain strings: this may be a lot of work - we have many URLs to add and thousands of term trackers
    • alternative: replace IAO:0000223 with editor notes or RDFS:comment
    • we could do more research before decision?
    • implementation could be done by @madbkr
    • having the history of issues is nice
  • decision: create subannotation of "editor note" -> term tracker annotation

stap-m avatar May 22 '24 06:05 stap-m

First try for a definition of term tracker annotation: A term tracker annotation is an editor note used within the Open Energy Ontology to track the history of a term. It tracks for each change the related GitHub issue and pull request.

l-emele avatar May 31 '24 08:05 l-emele

@stap-m : Any thoughts about my proposal in the comment above?

l-emele avatar Sep 02 '24 12:09 l-emele

I like the proposal. I don't think we should restrict it to the usage within OEO, esp with respect to new energy ontologies. What about: A term tracker annotation is an editor note used to track the history of an entity. For each change, it records the related GitHub issue and pull request.

stap-m avatar Sep 03 '24 06:09 stap-m

Being open for other ontologies is a good idea. So I agree to your improved definition.

To move on I suggest the following approach:

  1. One PR to introduce this new annotation property term tracker annotation first.
  2. Then one PR per OEO file to replace all uses of term tracker item with term tracker annotation. This can probably be done using search & replace in in a text editor.

l-emele avatar Sep 03 '24 06:09 l-emele

Sounds good to me. I'll create a PR for the new annotation.

stap-m avatar Sep 05 '24 07:09 stap-m

Reopen: Not completely finished, see https://github.com/OpenEnergyPlatform/ontology/pull/1922#issuecomment-2355068869

l-emele avatar Sep 17 '24 09:09 l-emele

Reopen: Not completely finished, see #1922 (comment)

@madbkr please have a look again.

stap-m avatar Sep 17 '24 11:09 stap-m

I re-open this issue:

While using term tracker annotation in #1925 I noticed that Protégé does not show the annotation properly: grafik

l-emele avatar Sep 19 '24 12:09 l-emele

Which class and module? I cannot reproduce that: grafik

stap-m avatar Sep 19 '24 12:09 stap-m

Oh, it is even weirder, the annotation appears twice, at least in oeo.omn:

grafik

l-emele avatar Sep 19 '24 13:09 l-emele

I don't have that either. Which branch?

stap-m avatar Sep 19 '24 13:09 stap-m

Branch feature-1873-licence-axioms of PR #1925.

It appears twice in if I look into the following files:

  • oeo.omn
  • oeo-physical-axioms.owl

In oeo-physical-axiom.owl it even shows: grafik Those two have the following IRIs:

  • http://openenergy-platform.org/ontology/oeo/OEO_00020426
  • http://openenergy-platform.org/ontology/oeo/oeo-physical-axioms/OEO_00020426

Looks like a bug in oeo-physical-axioms.owl. Maybe something with the namespaces?

l-emele avatar Sep 19 '24 13:09 l-emele