Skip to content
This repository has been archived by the owner on Oct 28, 2022. It is now read-only.

Change ontology term identifier #694

Merged
merged 6 commits into from
Feb 2, 2017
Merged

Conversation

david4096
Copy link
Member

@david4096 david4096 commented Aug 22, 2016

Ontology terms had an ambigious 'id' field and description. This PR renames the field to term_id to remove the confusion over the role of the field, as well as improves the comment for its proper use. A field 'term_uri' has been added that allows one to specify the full URI for a term if it is available.

Closes #621 #165

@mbaudis
Copy link
Member

mbaudis commented Aug 23, 2016

+1 Clear improvement.

@sarahhunt
Copy link
Contributor

+1

@mbaudis
Copy link
Member

mbaudis commented Aug 23, 2016

@david4096 (pls. don't forget the docs)

@david4096
Copy link
Member Author

Thanks @mbaudis updated with some minor tweaks to the ontology documentation.

@david4096
Copy link
Member Author

Related to discussion in #165

@mcourtot
Copy link

+1 with small modification (with input from @cmungall): "if no CURIE are available." -> "if no URI available".

@david4096
Copy link
Member Author

Thanks @mcourtot! Updated!

@mbaudis
Copy link
Member

mbaudis commented Aug 31, 2016

Please check termId => term_id (if I understand the proto snake_case correctly); same for termUri => term_uri. I usually do things like that with serarch/replace over the whole tree; but don't tell anybody, please.

If fixed -> merge.

@david4096
Copy link
Member Author

Thanks @mbaudis good to go!

required and implemented as URI
we assume this resolves to a meaningful document, e.g. http://purl.obolibrary.org/obo/SO_0000147
:termId:
The unique identifier of the term in an ontology source. This should be a CURIE (e.g., SO:0001234), but may be an alphanumerical string (e.g., 8000/3) if no CURIE are available.
:term:
Copy link

Choose a reason for hiding this comment

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

In the interest of reducing ambiguity, it may be worthwhile to have this field be termLabel:

Copy link
Member Author

Choose a reason for hiding this comment

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

Perhaps we can go forward with term_id and address the ambiguity in a later PR. We have improved over the field named id, however, there may be further room for improvement.

@david4096
Copy link
Member Author

Thanks everyone for your input @jmcmurry @mcourtot @drseb ! I'll be happy to integrate any further work on this data model as consensus is reached.

For now, I'd like to see if we can move ahead and take further discussion to another issue. This PR was designed to improve the situation from id to term_id and improve the comments, which it has done. To continue the discussion check out the below links:

Ontology Source Identification
Multiple Ontology Term URIs
OntologyTerm.id definition

@jmcmurry
Copy link

jmcmurry commented Sep 9, 2016

That sounds good to me; thanks @david4096

@cmungall
Copy link
Member

cmungall commented Oct 7, 2016 via email

@mbaudis
Copy link
Member

mbaudis commented Oct 7, 2016

@cmungall @drseb ... but reminding me of phenopackets/phenopacket-format#75

@mbaudis
Copy link
Member

mbaudis commented Oct 18, 2016

@mcourtot @cmungall @david4096 This should now be updated to reflect the Vancouver discussions.

@mcourtot
Copy link

Hm - I tried and push a commit to the pr/694 branch to reflect the Vancouver changes but don't see them here. Hadn't tried and commit over a PR before, so maybe i'm looking at the wrong place?

@david4096
Copy link
Member Author

@mbaudis @mcourtot I've incorporated your changes from #726 .

Since we have removed the URLs, I believe we need a way to manage them, or at least specify a place where they might be looked up. What do you think @cmungall ?

@mcourtot
Copy link

Thanks @david4096! We're planning on using OLS, http://www.ebi.ac.uk/ols/index to bind prefixes to their URIs. @simonjupp, @tburdett, do you have a specific link?

@david4096
Copy link
Member Author

david4096 commented Jan 19, 2017

Implemented in the server, client, and compliance.

david4096 and others added 5 commits February 1, 2017 22:51
Ontology terms had an ambigious 'id' field and description. This PR renames the field to term_id to remove the confusion over the role of the field, as well as improves the comment for its proper use. A field 'term_uri' has been added that allows one to specify the full URI for a term if it is available.
Change ontologies appendix documentation to reflect change
Slight formatting and wording adjustments of appendix doc
Change CURIE to URI
Fix casing
modified after Vancouver meeting to use CURIE throughout, remove
termURI and remove sourceName and source version.
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants