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

Request for new ontology [carolio] #2406

Closed
10 of 12 tasks
samie3000 opened this issue Jul 20, 2023 · 30 comments
Closed
10 of 12 tasks

Request for new ontology [carolio] #2406

samie3000 opened this issue Jul 20, 2023 · 30 comments
Assignees
Labels
new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted new ontology Use for new ontology registration requests

Comments

@samie3000
Copy link

samie3000 commented Jul 20, 2023

Title

Caroli's Disease and Syndrome

Short Description

Ontology for Symptoms, Outcomes, and Treatment of Caroli's Disease and Syndrome

Description

We aim to present CaroliO, an ontology for Caroli's disease and syndrome, which increases the potentials of enhancing diagnosis and treatment of these rare liver conditions.

Identifier Space

CaroliO

License

CC-BY 4.0

Domain

biological systems

Source Code Repository

https://github.com/TootooniLab/CaroliO

Homepage

https://github.com/TootooniLab/CaroliO

Issue Tracker

https://github.com/TootooniLab/CaroliO/issues

Contribution Guidelines

https://github.com/TootooniLab/CaroliO

Ontology Download Link

https://github.com/TootooniLab/CaroliO

Contact Name

Mohammad Samie Tootooni

Contact Email

[email protected]

Contact GitHub Username

samie3000

Contact ORCID Identifier

0000-0001-7235-4914

Formats

  • OWL RDF/XML (.owl)
  • OBO (.obo)
  • OBO Graph JSON (.json)

Dependencies

  • doid
  • symp
  • RO

Related

No response

Usages

No response

Intended Use Cases and/or Related Projects

No response

Data Sources

No response

Additional comments or remarks

No response

OBO Foundry Pre-registration Checklist

  • I have read and understood the registration process instructions and the registration checklist.
  • There is no other ontology in the OBO Foundry which would be an appropriate place for my terms. If there were, I have contacted the editors, and we decided in mutual agreement that a separate ontology is more appropriate.
  • My ontology has a specific release file with a version IRI and a dc:license annotation, serialised in RDF/XML.
  • I understand that term definitions, while not mandatory, are key to understanding the intentions of a term especially when the ontology is used in curation. I made sure that a reasonable majority of terms in my ontology have definitions, using the IAO:0000115 property.
  • For every term in my ontology, I checked whether another OBO Foundry ontology has one with the same meaning. If so, I re-used that term directly (not by cross-reference, by directly using the IRI).
  • For all relationship properties (Object and Data Property), I checked whether the Relation Ontology (RO) includes an appropriate one. I understand that aligning with RO is an essential part of the overall alignment between OBO ontologies!
  • For the selection of appropriate annotation properties, I looked at OMO first. I understand that aligning ontology metadata and term-level metadata is essential for cross-integration of OBO ontologies.
  • If I was not sure about the meaning of any of the checkboxes above, I have consulted with a member of the OBO Foundry for advice, e.g., through the obo-discuss Google Group.
  • The requested ID space does not conflict with another ID space found in other registries such as the Bioregistry and BioPortal, see here for a complete list.
@samie3000 samie3000 added the new ontology Use for new ontology registration requests label Jul 20, 2023
@pfabry
Copy link
Contributor

pfabry commented Jul 24, 2023

Dear @samie3000,

Thank you for your submission. The review will be executed as a two stage process.

  • First, you will have to pass the new ontology precheck, including the OBO NOR Dashboard. Pass means that no check apart from Users may be red.
  • After you have successfully passed these verfications, you will be assigned an OBO Operations committee member to review the ontology.

Usually, the review will result in an opportunity for you to improve the ontology. When the reviewer believes the ontology is ready for presentation to the OBO Operations Committee, they will present your ontology during an OBO Operations Call. This gives other members of the committee the opportunity to assess your work.

When a decision is reached by the committee you will be informed here on the issue tracker. The process can take any number of weeks or months, depending on the case at hand. Please inform us about any reasons you might have for increased urgency. You will be informed once your ontology is loaded in the OBO NOR Dashboard.

Good luck!

@ddooley ddooley added the new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted label Jul 25, 2023
@pfabry
Copy link
Contributor

pfabry commented Jul 25, 2023

Dear @samie3000,

Before going any further, the pre-registration checklist needs to be completed in full. In particular, some important OBO foundry principles need to be followed, such as:

  • Ontology IRI and version IRI following OBO Foundry syntax
  • Classes and properties IRIs following OBO Foundry syntax
  • Definitions using the IAO:0000115 property
  • Checking if classes and properties are not already exisitng in OBO Foundry ontologies

Thank you

@cthoyt
Copy link
Collaborator

cthoyt commented Aug 10, 2023

Several of the fields in this issue weren't filled out correctly (e.g., contribution guidelines link, ontology downloads link)

Based on the request, this ontology appears to explicitly overlap with existing OBO Foundry ontologies (HP/SYMP for symptoms, DOID/MONDO for diseases). Have you reached out to these ontologies to see if parts of yours would be able to be contributed there?

@nlharris
Copy link
Contributor

nlharris commented Sep 4, 2023

@samie3000 I hope you saw the questions and suggestions above and will respond soon!

@msabanluc
Copy link

Hello, my apologies for the late response. I'm managing the Carolio GitHub repository for samie3000. I believe the updated page and version of the ontology meets the requirements on the checklist and should be ready for review. Please let me know if there is anything further we need to do to move forward. We look forward to working with you throughout this process!

@matentzn matentzn added new ontology - reviewer required Indicates that an ontology is ready for review and removed new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted labels Oct 2, 2023
@matentzn
Copy link
Contributor

matentzn commented Oct 2, 2023

I believe the updated page and version of the ontology meets the requirements on the checklist and should be ready for review.

In response to @msabanluc comment I have checked all checkboxes above which makes this ontology request move to the next stage (reviewer assignment @pfabry), unless any NOR pre-checking requests still fail.

It is important that whoever reviews the ontology takes all comments, including the observations made by @pfabry and @cthoyt carefully into account during review.

@pfabry
Copy link
Contributor

pfabry commented Oct 2, 2023

@msabanluc
Thank you for the update. The ontology will now be added to the NOR dashboard to check any remaining issues.
In addition, are you the new contact for this ontology or is it still @samie3000 ?

@pfabry
Copy link
Contributor

pfabry commented Oct 3, 2023

@msabanluc @samie3000
The ontology is added to the NOR dashboard.
For the "Open" principle, you should replace <dc:license>http://creativecommons.org/licenses/by/4.0/</dc:license> with <terms:license>http://creativecommons.org/licenses/by/4.0/</terms:license> in the ontology header.

@cthoyt
Copy link
Collaborator

cthoyt commented Oct 3, 2023

It appears that PURLs are encoded incorrectly. Can we please add this as a check to the NOR dashboard? most contributors get the same feedback


    <!-- http://purl.obolibrary.org/obo/carolio.owl#radiation_therapy -->

    <owl:Class rdf:about="http://purl.obolibrary.org/obo/carolio.owl#radiation_therapy">
        <rdfs:subClassOf rdf:resource="http:/`/purl.obolibrary.org/obo/OGMS_0000090"/>
        <obo:IAO_0000115>is a treatment that uses high doses of radiation to kill cancer cells and shrink tumors. At low doses, radiation is used in x-rays to see inside body, as with x-rays of your teeth or broken bones. At high doses, radiation therapy kills cancer cells or slows their growth by damaging their DNA.</obo:IAO_0000115>
        <obo:IAO_0000119>https://www.cancer.gov/about-cancer/treatment/types/radiation-therapy</obo:IAO_0000119>
        <oboInOwl:hasOBONamespace>carolio</oboInOwl:hasOBONamespace>
        <oboInOwl:hasRelatedSynonym>radiotherapy</oboInOwl:hasRelatedSynonym>
        <rdfs:label>radiation therapy</rdfs:label>
    </owl:Class>

http://purl.obolibrary.org/obo/carolio.owl#radiation_therapy should be something like
http://purl.obolibrary.org/obo/CAROLIO_XXXXXXX, see https://obofoundry.org/id-policy

@pfabry
Copy link
Contributor

pfabry commented Oct 3, 2023

It appears that PURLs are encoded incorrectly. Can we please add this as a check to the NOR dashboard? most contributors get the same feedback


    <!-- http://purl.obolibrary.org/obo/carolio.owl#radiation_therapy -->

    <owl:Class rdf:about="http://purl.obolibrary.org/obo/carolio.owl#radiation_therapy">
        <rdfs:subClassOf rdf:resource="http:/`/purl.obolibrary.org/obo/OGMS_0000090"/>
        <obo:IAO_0000115>is a treatment that uses high doses of radiation to kill cancer cells and shrink tumors. At low doses, radiation is used in x-rays to see inside body, as with x-rays of your teeth or broken bones. At high doses, radiation therapy kills cancer cells or slows their growth by damaging their DNA.</obo:IAO_0000115>
        <obo:IAO_0000119>https://www.cancer.gov/about-cancer/treatment/types/radiation-therapy</obo:IAO_0000119>
        <oboInOwl:hasOBONamespace>carolio</oboInOwl:hasOBONamespace>
        <oboInOwl:hasRelatedSynonym>radiotherapy</oboInOwl:hasRelatedSynonym>
        <rdfs:label>radiation therapy</rdfs:label>
    </owl:Class>

http://purl.obolibrary.org/obo/carolio.owl#radiation_therapy should be something like http://purl.obolibrary.org/obo/CAROLIO_XXXXXXX, see https://obofoundry.org/id-policy

That's a good point and I was actually writing a issue about this. I believe that the ID policy should specify that a LOCALID must be of the form [0-9]7, and this information should be available directly in Principle#3.
However, some ontologies registered in the OBO Foundry, the Human Disease Ontology for example, uses URI of the form: http://purl.obolibrary.org/obo/IDSPACE#description_of_the_element, and a lot of annotation properties as well. On one hand we require the use of http://purl.obolibrary.org/obo/IAO_0000115 for definitions and on the other we use http://www.w3.org/2000/01/rdf-schema#label for the label.

@pfabry
Copy link
Contributor

pfabry commented Oct 3, 2023

@msabanluc @samie3000
On a technical point of view, the remaining issue with your ontology is the use of URIs for classes that do not follow the OBO Foundry ID policy as stated above. Could you please address this issue?

@msabanluc
Copy link

@pfabry
To respond to your comment from yesterday, @samie3000 is still the main contact for this ontology, but I can serve as a secondary contact if needed.

We will go ahead and address the the issues regarding the "open" principle as well as the incorrectly encoded URIs.

Aside from the LOCALID being a unique (relative to the ontology), 7-digit, zero-padded ID, are there any additional guidelines/conventions that should be followed when creating these?

Thank you for the feedback!

@pfabry
Copy link
Contributor

pfabry commented Oct 4, 2023

Aside from the LOCALID being a unique (relative to the ontology), 7-digit, zero-padded ID, are there any additional guidelines/conventions that should be followed when creating these?

That's the main issue but you will find the guideline relative to forming identifiers here.

@msabanluc
Copy link

@pfabry
I believe the updated ontology now addresses each of the above comments. Please let me know if any further changes need to be made. Thanks!

@cthoyt
Copy link
Collaborator

cthoyt commented Oct 8, 2023

  1. License on GitHub repository says CC BY-SA 4.0 and ontology says CC BY 4.0. OBO Foundry only allows ontologies with CC BY 4.0 or CC0. Please update the license
  2. Version IRI not annotated inside the ontology
  3. Version doesn't follow semantic versioning https://github.com/TootooniLab/CaroliO/blob/850d8c96d3ab408670485aa7fe4271f5e358e293/CaroliO.owl#L34 - Why not just make this simple as 2.0?
  4. http://purl.obolibrary.org/obo/carolio.owl#Definition appears. there's an IAO term for this
  5. Check for typos such as in https://github.com/TootooniLab/CaroliO/blob/850d8c96d3ab408670485aa7fe4271f5e358e293/CaroliO.owl#L167
  6. Underscores in labels (e.g., https://github.com/TootooniLab/CaroliO/blob/850d8c96d3ab408670485aa7fe4271f5e358e293/CaroliO.owl#L194C21-L194C34) and camel case in labels (e.g., https://github.com/TootooniLab/CaroliO/blob/850d8c96d3ab408670485aa7fe4271f5e358e293/CaroliO.owl#L352) are not enjoyable to read. please write them with normal spaces
  7. Please use ORCID identifiers for contributor information (e.g., change https://github.com/TootooniLab/CaroliO/blob/850d8c96d3ab408670485aa7fe4271f5e358e293/CaroliO.owl#L17 to be https://orcid.org/<INSERT CORRECT ORCID ID>)
  8. Many terms are still duplicating existing OBO terms. You can use the OLS to search for each term, such as "radiation therapy" to identify that MAXO already covers a lot of the "treatment" branch (see https://www.ebi.ac.uk/ols4/ontologies/maxo/classes/http%253A%252F%252Fpurl.obolibrary.org%252Fobo%252FMAXO_0000014)
  9. I don't think the purpose of SYMP is to be an "upper level ontology". Why not just contribute things like CAROLIO:0002000 (variceal bleeding) to SYMP or HPO directly?
  10. Similarly, why create a new term CAROLIO:0001000 (caroli syndrome) instead of contributing it to either DOID or MONDO?
  11. From looking at the new properties defined in this ontology, it appears they are used for axiom injection on DOID or other external terms. Please see the discussion at Define if and when it is OK to inject axioms into an external ontology #1443 on whether/when this is okay.

I think there are other things to address but these are the big ones for now

(note that mine isn't an official OBO review, just a drive by curator here)

@pfabry
Copy link
Contributor

pfabry commented Oct 10, 2023

@pfabry I believe the updated ontology now addresses each of the above comments. Please let me know if any further changes need to be made. Thanks!

@msabanluc Thank you for the update. Your ontology will now be reviewed by @handemcginty.

@pfabry pfabry added new ontology - reviewer response required Reviewer of this ontology needs to respond to an update or question. and removed new ontology - reviewer required Indicates that an ontology is ready for review labels Oct 10, 2023
@msabanluc
Copy link

@cthoyt
Thank you for the feedback! We've started addressing some of these issues you've pointed out, but I'm wondering if you can answer a few questions I have related to these:

  1. Version IRI not annotated inside the ontology

We've included the version IRI here: (https://github.com/TootooniLab/CaroliO/blob/050a97b7d714a733d03a7dbdeba55caef7e7b3cb/CaroliO.owl#L16)
Is there a different way to annotate this?

  1. Version doesn't follow semantic versioning https://github.com/TootooniLab/CaroliO/blob/850d8c96d3ab408670485aa7fe4271f5e358e293/CaroliO.owl#L34 - Why not just make this simple as 2.0?

For each version release, we have a basic (B) and applied (A) version, where the applied version includes more complex axioms to better reflect real world decision making in actual treatment, where the basic version follows the Open World Assumption and is suitable for ontologists and research. Do you have any suggestions for following semantic versioning while maintaining the applied vs basic releases?

  1. I don't think the purpose of SYMP is to be an "upper level ontology". Why not just contribute things like CAROLIO:0002000 (variceal bleeding) to SYMP or HPO directly?
  2. Similarly, why create a new term CAROLIO:0001000 (caroli syndrome) instead of contributing it to either DOID or MONDO?

We currently include these in the ontology as a placeholder. The goal is to contribute these to the respective existing ontologies as you mentioned and remove these.

@nlharris
Copy link
Contributor

@handemcginty have you had a chance to take a look at this yet?

@msabanluc
Copy link

@handemcginty Hi, I hope you are well! Do you have any updates on this?

@lschriml
Copy link
Contributor

Caroli syndrome has been added to the DO, DOID:0081394.
It will be publicly available in our next release.
Cheers,
Lynn

@handemcginty
Copy link

@msabanluc thanks for your patience during the review process and @cthoyt for your feedback.
Based on the guidelines and the latest files in the GitHub repo you linked here, I still have some questions and requests for you.
I see that you still haven't updated the issues @cthoyt already listed, for example using underscores in labels.
I also see several terms that may be added to existing ontologies such as @lschriml 's example of "Caroli syndrome" and I understand you created them as placeholders.
So could you please provide us with timelines for your term requests for your placeholder terms? Per the review guidelines, you alternatively can comment on why you needed your own term and how it may be different from the existing terminology.

Another issue regarding the reuse of terms exists when you inject different inverse properties for existing properties, this is the case for your "treats" property.
Could you please provide us with timelines for addressing this issue as well? This has also been addressed previously for this review by @cthoyt, reminding you here one more time.
Thanks again for your patience and looking forward to viewing the updated version. I will check back in a week and then again in two weeks.

@nlharris nlharris removed the new ontology - reviewer response required Reviewer of this ontology needs to respond to an update or question. label Nov 29, 2023
@nlharris nlharris added the new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted label Nov 29, 2023
@msabanluc
Copy link

@handemcginty Thank you for your feedback!

We've uploaded the updated file that address most of the issues listed by @cthoyt. They also address the issue regarding inverse property injection. These changes are not yet reflected in the 'applied' version, but will be shortly.

Regarding placeholder terms, I'm aware of 'caroli syndrome' and 'variceal bleeding'. We are currently identifying any other terms that may fit in existing ontologies and hope to get back to you sometime next week.

@msabanluc
Copy link

@handemcginty
After further inspection, I don't believe any of our other terms under treatment need to be added to existing ontologies. Please let me know if there are any specific terms that make more sense in existing ontologies. Regarding duplicates, I see some MAXO terms are also duplicated in other existing ontologies. What are the guidelines regarding duplicate terms with different definitions? I look forward to your review!

@matentzn matentzn added new ontology - reviewer response required Reviewer of this ontology needs to respond to an update or question. and removed new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted labels Jan 9, 2024
@lschriml
Copy link
Contributor

@handemcginty -- Hello Hande, can you please touch base on this ticket and provide feedback?

Cheers,
Lynn

@cthoyt
Copy link
Collaborator

cthoyt commented Jan 23, 2024

I wrote a script that checks for lexical matches between this proposal and existing ontologies in the OBO Foundry. Note that OBO Principle 10 "Commitment To Collaboration" states:

It is expected that Foundry ontologies will collaborate with other Foundry ontologies, particularly in ensuring orthogonality of distinct ontologies, in re-using content from other ontologies in cross-product definitions where appropriate, and in establishing and evolving Foundry principles to advance the Foundry suite of ontologies to better serve the joint users.

Below are the results. A case can be made that it's okay to duplicate NCIT terms since this is just an obo export of a resource that does not actually participate in the open community.

Lexical matching returned results

  • CAROLIO:0000411 mild pain
  • CAROLIO:0000412 moderate pain
  • CAROLIO:0000413 no pain
  • CAROLIO:0000414 severe pain
  • CAROLIO:0001000 caroli syndrome
  • CAROLIO:0003100 endoscopic treatment
  • CAROLIO:0003120 endoscopic retrograde cholangiopancreatography
    • maxo:0035049 endoscopic retrograde cholangiopancreatography (0.778)
    • ncit:C16430 Endoscopic Retrograde Cholangiopancreatography (0.762)
  • CAROLIO:0003200 interventional radiology procedure
    • ncit:C63334 Interventional Radiology Procedure (0.762)
  • CAROLIO:0003210 locoregional therapy
  • CAROLIO:0003220 paracentesis
  • CAROLIO:0003250 transjugular intrahepatic portosystemic shunt
    • ncit:C126288 Transjugular Intrahepatic Portosystemic Shunt (0.762)
  • CAROLIO:0003300 pharmaceutical treatment
  • CAROLIO:0003310 antibiotic treatment
  • CAROLIO:0003320 antiemetic treatment
  • CAROLIO:0003330 bile acid treatment
  • CAROLIO:0003340 chemotherapy
  • CAROLIO:0003350 diuretics treatment
  • CAROLIO:0003360 octreotide treatment
  • CAROLIO:0003370 proton pump inhibitor treatment
  • CAROLIO:0003380 pruritus treatment
  • CAROLIO:0003400 radiation therapy
  • CAROLIO:0003500 surgical treatment
  • CAROLIO:0003510 organ transplant
  • CAROLIO:0003520 roux-en-y
  • CAROLIO:0003530 surgical resection

Lexical matching returned no results

  • CAROLIO:0000400 value partition
  • CAROLIO:0000410 pain scale
  • CAROLIO:0000420 symptom recurrence status
  • CAROLIO:0000421 non-recurrent symptom status
  • CAROLIO:0000422 recurrent symptom status
  • CAROLIO:0002000 variceal bleeding
  • CAROLIO:0003110 endoscopic band ligation
  • CAROLIO:0003121 biliary drainage
  • CAROLIO:0003122 biliary dilatation
  • CAROLIO:0003123 biliary stent placement
  • CAROLIO:0003124 gallstones removal
  • CAROLIO:0003230 percutaneous aspiration and drainage
  • CAROLIO:0003240 percutaneous transhepatic cholangiogram

However, these have big overlap with MAXO and SYMP/HP, and should be considered to be submitted there.

@handemcginty
Copy link

Thanks again @cthoyt for all your help during this review including the script you wrote to check the overlapping list of terms. @msabanluc I assume that you are still reviewing these terms and identifying overlapping terms. In the previous meeting, the operations committee agreed that we would ask you to create git issues for overlapping terms. We understand that there may be a delay in the creation of these terms in the target ontologies, however, lack of effort is against the OBO guidelines for accepting the ontology as is.
Thanks again for your patience and please let us know when there is an updated version.

@msabanluc
Copy link

Hi @handemcginty, thank you for the update. We've started reviewing these terms and will address terms overlapping with MAXO such as:

  • endoscopic retrograde cholangiopancreatography
  • paracentesis
  • pharmaceutical treatment/pharmacotherapy
  • chemotherapy
  • radiation therapy
  • surgical resection

Can you please clarify what you mean by creating git issues for these?

We believe the other CAROLIO terms listed are unique and do not overlap with the suggested terms.
We've also begun reflecting changes in the ontology, which will be available on our GitHub page soon.
For example, we've added the DOID definition of 'Caroli syndrome' (DOID:0081394).

We've also contributed our definitions to ontology terms without existing definitions, such as:
SYMP_0000421 - Hematochezia
and
SYMP_0000295 - Hepatic abscess

I will let you know when the updated version reflecting these changes is available. Thanks!

@handemcginty
Copy link

Thank you so much for the update @msabanluc . What I meant by creating git issues is that we wanted to see git issues for requests for new term additions or edits to existing terms for the terms outlined previously. Thanks again and looking forward to your ping when you are ready.

@nlharris nlharris added new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted and removed new ontology - reviewer response required Reviewer of this ontology needs to respond to an update or question. labels Mar 5, 2024
@nlharris
Copy link
Contributor

@msabanluc just wondering how this is going!

@handemcginty
Copy link

@msabanluc Due to inactivity for the past two months, this issue will be closed. When you are ready, you are welcome to open this issue again. Thanks for your interest in submitting your ontology to OBO Foundry.

@anitacaron anitacaron closed this as not planned Won't fix, can't repro, duplicate, stale May 28, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new ontology - submitter action needed New ontology requests that have been reviewed and need changes in order to be accepted new ontology Use for new ontology registration requests
Projects
None yet
Development

No branches or pull requests

10 participants