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

reconsidering the usage of term tracker item #1850

Closed
5 tasks
stap-m opened this issue May 3, 2024 · 15 comments · Fixed by #1922, #1923 or #1926
Closed
5 tasks

reconsidering the usage of term tracker item #1850

stap-m opened this issue May 3, 2024 · 15 comments · Fixed by #1922, #1923 or #1926
Assignees
Labels
[C] definition update Update an ontology definition Depends on other issue or PR Cannot be solved / implemented until another issue or PR is solved. enhancement New feature or request external ontology external ontologies that could be included oeo dev meeting Discuss issue at oeo dev meeting ontology infrastructure

Comments

@stap-m
Copy link
Contributor

stap-m commented May 3, 2024

Description of the issue

This comes from information-artifact-ontology/ontology-metadata#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 stap-m added [C] definition update Update an ontology definition To do Issues that haven't got discussed yet labels May 3, 2024
@stap-m stap-m self-assigned this May 3, 2024
@stap-m stap-m added this to the oeo-release-2.4.0 milestone May 3, 2024
@stap-m stap-m added enhancement New feature or request oeo dev meeting Discuss issue at oeo dev meeting external ontology external ontologies that could be included ontology infrastructure Depends on other issue or PR Cannot be solved / implemented until another issue or PR is solved. labels May 3, 2024
@l-emele
Copy link
Contributor

l-emele commented May 6, 2024

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

@stap-m
Copy link
Contributor Author

stap-m commented May 7, 2024

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
Copy link
Contributor Author

stap-m commented May 22, 2024

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

@github-actions github-actions bot removed the To do Issues that haven't got discussed yet label May 22, 2024
@l-emele
Copy link
Contributor

l-emele commented May 31, 2024

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
Copy link
Contributor

l-emele commented Sep 2, 2024

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

@stap-m
Copy link
Contributor Author

stap-m commented Sep 3, 2024

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.

@l-emele
Copy link
Contributor

l-emele commented Sep 3, 2024

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.

@stap-m
Copy link
Contributor Author

stap-m commented Sep 5, 2024

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

stap-m added a commit that referenced this issue Sep 5, 2024
stap-m added a commit that referenced this issue Sep 9, 2024
…acker-annotation

add `term tracker annotation` property #1850
madbkr added a commit that referenced this issue Sep 17, 2024
…d-term-tracker-item-with-term-tracker-annotation

replaced term tracker item with term tracker annotation #1850
@github-project-automation github-project-automation bot moved this from In discussion to Done in Issues Sep 17, 2024
@l-emele
Copy link
Contributor

l-emele commented Sep 17, 2024

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

@l-emele l-emele reopened this Sep 17, 2024
@github-project-automation github-project-automation bot moved this from Done to In discussion in Issues Sep 17, 2024
@stap-m
Copy link
Contributor Author

stap-m commented Sep 17, 2024

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

@madbkr please have a look again.

stap-m added a commit that referenced this issue Sep 19, 2024
…d-more-term-tracker-item-with-annotation

replaced more term tracker items with annotation #1850
@github-project-automation github-project-automation bot moved this from In discussion to Done in Issues Sep 19, 2024
@l-emele
Copy link
Contributor

l-emele commented Sep 19, 2024

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 l-emele reopened this Sep 19, 2024
@github-project-automation github-project-automation bot moved this from Done to In discussion in Issues Sep 19, 2024
@stap-m
Copy link
Contributor Author

stap-m commented Sep 19, 2024

Which class and module?
I cannot reproduce that:
grafik

@l-emele
Copy link
Contributor

l-emele commented Sep 19, 2024

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

grafik

@stap-m
Copy link
Contributor Author

stap-m commented Sep 19, 2024

I don't have that either. Which branch?

@l-emele
Copy link
Contributor

l-emele commented Sep 19, 2024

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:

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

stap-m added a commit that referenced this issue Sep 19, 2024
bugfix duplicate annotation declaration in oeo-physical-axioms #1850
@stap-m stap-m closed this as completed Sep 20, 2024
@github-project-automation github-project-automation bot moved this from In discussion to Done in Issues Sep 20, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment