Adding Terms and Regenerating the Import Files: Difference between revisions

From GO Wiki
Jump to navigation Jump to search
(Created page with "=TO BE FORMATTED= Terms are imported to GO from other ontologies, but not all terms from external ontologies are imported. Occasionally, you will find that a valid identifie...")
 
mNo edit summary
 
(21 intermediate revisions by 3 users not shown)
Line 1: Line 1:
=TO BE FORMATTED=


  See [[Ontology_Editors_Daily_Workflow]] for creating branches and basic Protégé instructions.
==Adding terms to import files==
Terms are imported to GO from other ontologies, but not all terms from external ontologies are imported. Occasionally, you will find that a valid identifier exists in an external ontology, but the identifier is not available in Protege because that term is not yet imported. To import a term from an external ontology:
Terms are imported to GO from other ontologies, but not all terms from external ontologies are imported. Occasionally, you will find that a valid identifier exists in an external ontology, but the identifier is not available in Protege because that term is not yet imported. To import a term from an external ontology:


    Navigate to the imports folder on GitHub, located at https://github.com/geneontology/go-ontology/tree/master/src/ontology/imports.
# Navigate to the imports folder on GitHub, located at https://github.com/geneontology/go-ontology/tree/master/src/ontology/imports.
    Look in the list of ontologies for the ontology that contains the term you wish to import.
# Look in the list of ontologies for the ontology that contains the term you wish to import.
    Identify the ontology_terms.txt file for the target ontology. For example, for the addition of a new taxon, the file can be found at https://github.com/geneontology/go-ontology/blob/master/src/ontology/imports/ncbitaxon_terms.txt.
# Identify the ontology_terms.txt file for the target ontology. For example, for the addition of a new taxon, the file can be found at https://github.com/geneontology/go-ontology/blob/master/src/ontology/imports/ncbitaxon_terms.txt.
    Click on the icon of a pencil in the upper right corner of the window to edit the file.
## Note that the different import files have different example lines. Be sure to follow the correct format if you are using the IRIs. There is an underscore between the prefix and the term identifier:  https://github.com/geneontology/go-ontology/blob/master/src/ontology/imports/chebi_terms.txt
    Add the new term on the next available line at the bottom of the file.
# Click on the icon of a pencil in the upper right corner of the window to edit the file.
    Click preview changes.
# Add the new term on the next available line at the bottom of the file.
    You can now either commit the file directly to master or create a branch and a pull request as described before.
# Click preview changes.
# Create a new branch and a pull request as described in the [[Ontology_Editors_Daily_Workflow]].
  Note that you can also edit the file in your local machine and commit as part of the same branch as the ontology changes. 
 
  See [[Ontology_Editors_Daily_Workflow]] for commit, push and merge instructions.
 
==Regenerating import files Manually==
 
#Install docker [https://www.docker.com/] on your local machine
  After installing, in the docker tool, select preferences, then go to 'advanced" and use the sliders to set the memory to 14 gig.  Press 'apply and restart'
  Note: docker must be running in order for the following steps to work
#Create a new branch for regenerating the import: git checkout -b chebi-import-2018-09-10
#The command for regenerating imports is: ./run.sh make imports/something_import.obo (Generating the obo file will automatically generate the owl file.)
#Once the file is regenerated, sanity check it with a git diff
#If all looks good, commit the new file and push it to origin.
#Create a pull request. If all checks pass, merge.
 
==Checking automatic import files From Ontobot==
* Taxon constrains get regenerated daily. Other imports weekly.
 
== Review Status ==
 
Last reviewed: May 24, 2017
 
[[Ontology_Development#Editing_the_Ontology |Back to: Editing the Ontology]]
 


[[Category:GO Editors]][[Category:Ontology]][[Category:Editor_Guide_2018]]
[[Category:GO Editors]][[Category:Ontology]][[Category:Editor_Guide_2018]]

Latest revision as of 13:34, 10 February 2020

 See Ontology_Editors_Daily_Workflow for creating branches and basic Protégé instructions.

Adding terms to import files

Terms are imported to GO from other ontologies, but not all terms from external ontologies are imported. Occasionally, you will find that a valid identifier exists in an external ontology, but the identifier is not available in Protege because that term is not yet imported. To import a term from an external ontology:

  1. Navigate to the imports folder on GitHub, located at https://github.com/geneontology/go-ontology/tree/master/src/ontology/imports.
  2. Look in the list of ontologies for the ontology that contains the term you wish to import.
  3. Identify the ontology_terms.txt file for the target ontology. For example, for the addition of a new taxon, the file can be found at https://github.com/geneontology/go-ontology/blob/master/src/ontology/imports/ncbitaxon_terms.txt.
    1. Note that the different import files have different example lines. Be sure to follow the correct format if you are using the IRIs. There is an underscore between the prefix and the term identifier: https://github.com/geneontology/go-ontology/blob/master/src/ontology/imports/chebi_terms.txt
  4. Click on the icon of a pencil in the upper right corner of the window to edit the file.
  5. Add the new term on the next available line at the bottom of the file.
  6. Click preview changes.
  7. Create a new branch and a pull request as described in the Ontology_Editors_Daily_Workflow.
  Note that you can also edit the file in your local machine and commit as part of the same branch as the ontology changes.  
 See Ontology_Editors_Daily_Workflow for commit, push and merge instructions.

Regenerating import files Manually

  1. Install docker [1] on your local machine
  After installing, in the docker tool, select preferences, then go to 'advanced" and use the sliders to set the memory to 14 gig.  Press 'apply and restart'
  Note: docker must be running in order for the following steps to work
  1. Create a new branch for regenerating the import: git checkout -b chebi-import-2018-09-10
  2. The command for regenerating imports is: ./run.sh make imports/something_import.obo (Generating the obo file will automatically generate the owl file.)
  3. Once the file is regenerated, sanity check it with a git diff
  4. If all looks good, commit the new file and push it to origin.
  5. Create a pull request. If all checks pass, merge.

Checking automatic import files From Ontobot

  • Taxon constrains get regenerated daily. Other imports weekly.

Review Status

Last reviewed: May 24, 2017

Back to: Editing the Ontology