Add new terms
Add New Terms to Mondo¶
Before you start:¶
- make sure your Protege is setup (see instructions here).
- make sure you are working on a branch in GitHub
Creating a new class¶
New classes are created in the Class hierarchy panel on the left.
There are three buttons at the top of the class hierarchy view. These allow you to add a subclass (L-shaped icon), add a sibling class (c-shaped icon), or delete a selected class (x'd circle).
Add a new term:¶
- Search for the parent term
- When you are clicked on the term in the Class hierarchy pane, click the add subclass button to add a child class
A dialog will popup. Add the name of the new term, see example below. Click "OK" to add the class.
Adding annotations¶
Using Protégé you can add annotations such as labels, definitions, synonyms, database cross references (dbxrefs) to any OWL entity. The panel on the right, named Annotations, is where these annotations are added. CL includes a pre-declared set of annotation properties. The most commonly used annotations are below.
- rdfs:label
- definition
- has_exact_synonym
- has_broad_synonym
- has_narrow_synonym
- has_related synonym
- database_cross_reference
- rdfs:comment
Note, most of these are bold in the annotation property list:
Use this panel to add a definition to the class you created. Select the + button to add an annotation to the selected entity. Click on the annotation 'definition' on the left and add the definition to the white editing box on the right. Click OK.
For example:
Definitions in Mondo should have a 'database cross reference' (dbxref), which is a reference to the definition source, such as a paper from the primary literature or another database. For references to papers, we cross reference the PubMed Identifier in the format, PMID:XXXXXXXX. (Note, no space)
To add a dbxref to the definition:
- Click the @ symbol next to the definition
- Click the + button next in the pop-up window
- Scroll up on the left hand side until you find 'database_cross_reference', and click it
- Add a dbxref. If adding a PubMed ID, it should be in the format PMID:XXXXXX, for example PMID:25527564. _Note: the PMID should not have any spaces)
- Click OK
- If you need to add more than one dbxref, repeat the steps from the beginning.
- The dbxref(s) should appear as below.
See example below:
Add Synonyms¶
- Synonyms should be exact, narrow, broad or related. Select appropriate annotation: 'has_exact_synonym', etc. Click here for more details on synonym scopes.
-
All synonyms in Mondo should have a dbxref on the synonym
-
Click the add annotations button
- Select 'has_exact_synonym' (or other 'has_synonym...'' type as needed)
- Add the synonym label in the white box
- Click OK
- Click the @ symbol next to the synonym
- Click the + button
- Add the dbxref to each synonym: Select database_cross_reference, and add dbxref in white box
- Click OK
- Click OK
Synonym types:¶
Synonyms can be further annotated with synonym types. Click here for a summary and description of synonym types in Mondo.
Add a synonym annotation in Protege¶
- Click on the synonym
- Click the @ symbol on the synonym
- Click
Annotations
+ - Click
has_synonym_type
on the left - Click
Entity IRI
on the top of the box - Click
Annotation properties
on the top of the box - Scroll to bottom, and show annotation below
synonym_type_property
(click triangle) - Select appropriate synonym type (e.g.
A synonym that is historic and discouraged
). - Click OK
Add Database cross reference¶
-
Database cross references to other source ontologies and terminologies can be added to terms
-
Click the add annotations buttons
- Select 'database_cross_reference'
- Add the dbxref in the white carboxylase
- Click OK
- Add Axiom Annotation: Click the @ symbol next to the dbxref
- Click the + button
- Click source
- Add source in the white box, such as MONDO:equivalentTo. See Axiom Annotation Summary Table for all types of axiom annotations.
- Click OK
- Click OK
Add source to parent (subClassOf assertion)¶
In Mondo, all of the parents (subClassOf assertions) should have a source, so we capture the provenance of where the superclass (subClassOf/parent) assertion came from.
- Click on the @ symbol next to the parent class
- Click the + next to Annotations in the pop up box
- Select source from the annotations list
- Add a source, such as an OMIM or Orphanet ID, your ORCID, or a PMID ID.
- Note - you can add more than one source, as displayed in the example below.
Add subset tags¶
- See a description of subsets here.
- To add a subset tag, click the + above Annotations in the Annotations box
- Chose in_subset in the annotations list
- Click Entity IRI tab
- Click Annotation Properties tab
- Scroll down to subset_property and expand the list
- Chose subset tag, such as obsoletion_candidate
Commit to GitHub¶
Save your work and view the diff in GitHub Desktop and create a pull request.