SETTING UP
Editing environment
- Install Protege 5.2 or higher. Protege 5.5 is currently available and most editors are using this version now.
- Opitional: Install any additional plugins from: http://wiki.geneontology.org/index.php/Ontology_editor_plugins
- Install the Elk plugin from https://github.com/liveontologies/elk-reasoner/wiki/GettingElk (Put the plugin into the Protege/plugins directory, see instructions below.)
PRE-EDIT CHECKLIST
Setting your ID ranges
Do you have an ID range in the idranges file (cro-idranges.owl), in the src/ontology/ directory)? If not, Nicole or Marijane can add one for you.
Ensure that you have Protege configured to generate new URIs in your own range. Note that if you edit multiple files, you need to check this every time to ensure that the proper settings are in place. HP URIs should look like this: http://purl.obolibrary.org/obo/CRO_0000006 Do a test to ensure that the ID generator is working properly.
A word of caution about protege auto-id functionality. Protege will allow reuse of a URI in your range according to the numbering scheme. It will keep track of what you did during last session, but does not check for use of the URI before assigning it. Therefore, if you switched between editing another ontology, or added any IDs in your range prior to the switch to OWL, Protege will not know not to start from the beginning. Some tips below to check to see where you are in your range. Note: if you only edit the CRO and do not edit other ontologies, you will only need to set this up once, Protege will remember your last ID between sessions.
- Open the file cro-idranges.owl in src/ontology in a text editor (like TextEdit) and check your ID range (start and end).
-
In Protege, go to the View menu, click “render by entity IRI short name (Id)”. This will display classes as “CRO_0030021” etc.
-
Use the search box to search for classes starting within your range, such as “CRO_20” for Marijane’s range. Check the “show all results” box to see all of your results.
-
Find the last used ID in your range, e.g. CRO_2000008.
-
Go to Protege->Preferences, and click the New Entities tab. Set Protege to the next unused ID in your range (e.g., “CRO_00400009”) rather than the beginning of the range.
- To do so (assuming you are using Protege 5), go to Protege->Preferences window and find the “New Entities” tab. The following settings are correct:
- Start with “Specified URI”: http://purl.obolibrary.org/obo/
- Followed by “/”
- End with “autogenerated ID”
- Entity label “custom label”: http://www.w3.org/2000/01/rdf-schema#label
- Autogenerated ID “numeric”, prefix “CRO_”, digit count “7”, start (next unused ID in your range), end (last ID in your range)
- Finally, tick the box “remember last ID between Protege sessions”
For instance, Marijane’s range is 2000000-2999999
Note that you can use ctrl-U to see the IRI of the current entity. If you click on “show full IRI”, you should see something like this: http://purl.obolibrary.org/obo/CRO_20000006
Protege should then remember your last used ID on the computer you are currently using for next time, though you should double check.
(You can ignore this if you do not intend to create new classes)
Finally, go to Protege->Preferences, “New Entities Metadata” tab and set “http://www.geneontology.org/formats/oboInOwl#created_by”. This will ensure that we are all using the same tag to get credit for making new terms.
Obsolescence plugin
Get Jim’s awesome obsolescence is automatically installed with Protege 5.5. If you do not see it, you can install through the Protege Check for plugins...
menu.
Elk reasoner
Installing ELK:
1) Go to the ELK pages 2) Scroll down and click on Protege Plugin latest build 3) When downloaded, unzip and copy puli and elk jars (two .jar files) in the unpacked directory. 4) Paste these files in your Protege plugin directory. This is in one of two locations:
- ~/.Protege/plugins (note this is usually hidden from finder, but you can see it in the terminal) or
- Go to Protege in Applications (Finder), right click, ‘Show package contents’ -> Java -> plugins