Difference between revisions of "BioPortal Import Plugin"

From Protege Wiki
Jump to: navigation, search
(Configuring properties to be imported)
 
(44 intermediate revisions by 2 users not shown)
Line 1: Line 1:
 
{{Plugin
 
{{Plugin
|Description=The BioPortal Import Plugin allows the user to import classes from external ontologies stored in BioPortal. The user can import entire trees of classes with a desired depth and choose which properties to import for each class.
+
|Description=The BioPortal Import Plugin allows users to import classes from external ontologies stored in the BioPortal ontology repository. The user can import entire trees of classes with a desired depth and choose which properties to import for each class. This plugin works with Protege 3.x releases, not Protege 4.x.
|PluginType=Slot Widget
+
|PluginType=Project
 
|ForApplication1=Protege-OWL
 
|ForApplication1=Protege-OWL
 +
|Screenshot=BPImportPlugin.png
 
|HomepageURL=http://protegewiki.stanford.edu/index.php/BioPortal_Import_Plugin
 
|HomepageURL=http://protegewiki.stanford.edu/index.php/BioPortal_Import_Plugin
 
|DeveloperID1=Jithun Nair
 
|DeveloperID1=Jithun Nair
 
|DeveloperID2=Tania Tudorache
 
|DeveloperID2=Tania Tudorache
|LastUpdated=April 12, 2011
+
|LastUpdated=July 15, 2011
|Topic1=Biomedical Informatics
+
|Topic1=Import
|Topic2=Search
+
|Topic2=Terminologies
|Topic3=Navigation
+
|Topic3=Biomedical Informatics
|Topic4=Terminologies
+
|License=Mozilla Public License (MPL)
|Topic5=Import
 
|License=MPL
 
 
|Affiliation1=Stanford Center for Biomedical Informatics Research
 
|Affiliation1=Stanford Center for Biomedical Informatics Research
 
}}
 
}}
 
<div style="display:block; float:left; width:100%;">
 
<div style="display:block; float:left; width:100%;">
  
`
+
 
 
= Overview =
 
= Overview =
  
The BioPortal Reference plugin is added as an action to the OWLClasses tab of the Protege-OWL user interface. The plugin allows a user to import classes from external BioPortal ontologies into a local ontology in Protege-OWL. The basic steps in using the plugin are to: a) browse through all the BioPortal ontologies (except remote ones) and select which one to import classes from; b) select one or more classes to import from the BioPortal ontology, and c) import them as subclasses of the selected class in the local ontology.
+
<div style="background: #FDECE7; border: 2px solid #AE5B08; padding: 10px 15px 10px 20px; margin: 30px 430px 0 0; ">
 +
 
 +
'''As of May 2014, the BioPortal Import plugin does not work anymore.'''
 +
 
 +
BioPortal has updated its [http://data.bioontology.org/documentation REST APIs] and the plugin has not been ported to the new API, yet. We plan to add this functionality to [[WebProtege]]. Follow [https://github.com/protegeproject/webprotege/issues/152 this GitHub issue] for updates.
  
The plugin uses the RESTful services provided by BioPortal to allow the user to browse through the latest versions of all BioPortal ontologies. However, remote ontologies (identified by the value of their isRemote property) cannot be explored in the plugin, since BioPortal does not provide the information for these ontologies through its REST services. The user can view the classes of the selected ontology in an expandable tree format, and also view the properties of each class.
+
As a work around for now, you may open the BioPortal ontology directly in Protege 5.x, and edit it (for example, extract branch by deleting the rest of the ontology, or by using the Refactor menu -> Copy/move/delete axioms). To open the BioPortal ontology in Protege 5.x, do these simple steps:
  
The plugin is configurable and works with Protege-OWL. The configurations provide users with the ability to: a) import entire subtrees of classes from BioPortal ontologies; b) save the imported classes as a separate ontology and/or as a file to the local disk, and c) choose which (if any) property values to import for each class and assign an equivalent user property for each imported property, if desired.
+
# Copy the download link of the ontology from the ontology summary view in BioPortal (e.g., right-click on the link -> Copy link address)
 +
# Start Protege 5.x
 +
# Go to File menu -> Open from URL, and paste the link in the box
 +
 
 +
</div>
 +
 
 +
The plugin allows a user to '''import classes from external ontologies and terminologies stored in the [http://bioportal.bioontology.org BioPortal ontology repository]''' into the local ontology.
 +
 
 +
'''This plugin works with the Protege 3.x releases, not Protege 4.x releases'''. We plan to have an implementation of this plugin also in Protege 4 as part of the future work. If you are using Protege 4 to develop your ontology, you can still use this plugin by opening the OWL file in Protege 3.x, make the import, save, and then continue to develop the ontology in Protege 4.
 +
 
 +
The basic '''steps''' in using the plugin are to:
 +
 
 +
# browse through the BioPortal ontologies (except remote ones) and select which one to import classes from
 +
# select one or more classes to import from the BioPortal ontology,
 +
# configure the import,
 +
# import them as subclasses of the selected class in the local ontology.
 +
 
 +
 
 +
The plugin uses the '''[http://www.bioontology.org/wiki/index.php/NCBO_REST_services BioPortal REST services]''' to access and import the content of BioPortal ontologies. However, ontologies denoted as ''remote'' in BioPortal cannot be explored in the plugin, since BioPortal does not provide the information for these ontologies through its REST services.
 +
 
 +
The BioPortal Import plugin is added as a button to the OWL Classes tab of the Protege-OWL 3.x user interface. The user can browse the class tree of the selected BioPortal ontology right from the Protege desktop interface, and also view the properties of each class.
 +
 
 +
 
 +
The plugin is configurable and works with Protege-OWL. The '''import configuration''' allows the user to customize the import and it includes:
 +
 
 +
* import entire subtrees of classes from BioPortal ontologies
 +
* save the imported classes as a separate ontology and/or as a file to the local disk
 +
* choose which (if any) property values to import for each class and assign an equivalent user property for each imported property, if desired
 +
* import metadata at the level of a class or the ontology (e.g. import author, timestamp, source ontology and version, etc.)
 +
 
 +
 
 +
A related plugin to this one that allows users to create reference to classes in BioPortal (rather than importing them) is the '''[[BioPortal_Reference_Plugin|BioPortal Reference Plugin]]'''.
  
  
 
= What does it look like =
 
= What does it look like =
  
This is a screenshot of the BioPortal Import plugin showing the SNOMED CT ontology classes:
+
This is a screenshot showing the NCI Thesaurus loaded in Protege, and the SNOMED CT terminology browsed in the BioPortal Import Panel.
  
  
[[File:Import_classes_from_BioPortal.png]]
+
[[File:BPImportPlugin.png]]
  
  
 
= How to use it =  
 
= How to use it =  
  
The BioPortal Import plugin can be invoked by selecting a class of a domain ontology in the <code>OwlClasses</code> tab in Protege-OWL and then clicking on the icon as shown below:
+
The BioPortal Import plugin can be invoked by selecting a class of a domain ontology in the ''OWL Classes Tab'' (that will serve as the superclass of the imported classes), and then clicking on the BioPortal Import icon as shown below:
  
 
[[File:BioPortal_Import_Plugin_icon.png]]
 
[[File:BioPortal_Import_Plugin_icon.png]]
Line 44: Line 78:
 
== Importing classes ==
 
== Importing classes ==
  
In the plugin window, select a BioPortal ontology from the dropdown list.
+
In the BioPortal import panel, '''select a BioPortal ontology''' from the drop-down list. You may also start typing words from ontology name, and an auto-complete feature will display suggestions.
  
  
Line 50: Line 84:
  
  
The plugin will show all the classes belonging to the selected ontology in an expandable tree format in the left pane. Selecting one of the classes will show the properties for that class in the details pane. Select one or more classes to import from the BioPortal ontology.
+
The plugin will show the '''class tree of the selected BioPortal ontology''' in an expandable tree format in the left pane. Selecting one of the classes will show the '''properties for that class''' in the details pane on the right hand side. You may '''select one or more classes to import from the BioPortal ontology'''.
  
  
Line 56: Line 90:
  
  
Configure the settings for importing classes by clicking on the "''Configure Import...''" button. More details about configuring the settings are provided in the "Plugin Configuration" section below.
+
Next, '''configure the import settings''' by clicking on the ''1. Configure Import...'' button. More details about configuring the settings are provided in the section below.
  
Click on the "''Import''" button to import all selected classes into the local ontology.  
+
Once you have configured the import, '''click on the ''2. Import'' button to import''' all selected classes into the local ontology in Protege.  
  
Below is an example of the <code>Mosquito-borne flavivirus hemorrhagic fever</code> class (Term ID 240489005) of the SNOMED CT ontology imported into the <code>Abnormal_Cell</code> class of the NCI Thesaurus ontology.
+
Below is an example of the class ''Brain part'' (Term ID 119235005) of the SNOMED CT ontology imported as a subclass of ''Body part'' class in the NCI Thesaurus ontology.
  
  
Line 66: Line 100:
  
  
== Plugin configuration ==
+
== Import configuration ==
 +
 
 +
There are two ways to configure the import process:
  
The user can configure the settings for all the above features of the plugin in two ways: 1. selecting "''BioPortal>Configure...''" from the Protege window menu bar, or 2. clicking on "''Configure Import...''" in the plugin window. It also allows the user to configure the base URL for BioPortal and BioPortal REST services, if required.
+
# Using the menu ''BioPortal -> Configure...'', or  
 +
# Clicking on ''1. Configure Import...'' at the bottom of the BioPortal import panel.  
  
=== Configuring Imports ===
 
  
==== Importing a subtree of classes ====
+
=== Importing a subtree of classes ===
  
 
If the user wants to import an entire subtree of classes, the plugin provides an option to enable it, as well as to configure the number of levels down the tree to import, starting from the children of the selected class. This makes it very convenient to import entire parts of an ontology at once.
 
If the user wants to import an entire subtree of classes, the plugin provides an option to enable it, as well as to configure the number of levels down the tree to import, starting from the children of the selected class. This makes it very convenient to import entire parts of an ontology at once.
Line 80: Line 116:
  
  
==== Importing into a separate ontology ====
+
=== Importing into a separate ontology ===
  
 
Often, a user might want to import classes into a separate ontology, which can then be imported into the main ontology. One advantage of this is that the imported classes can be edited and maintained separately. It also makes removing all the imports altogether much easier. If so desired, the user can configure whether he/she wants to import the selected classes into an entirely new ontology (in which case the ontology name and the name of the file to save it to needs to be  
 
Often, a user might want to import classes into a separate ontology, which can then be imported into the main ontology. One advantage of this is that the imported classes can be edited and maintained separately. It also makes removing all the imports altogether much easier. If so desired, the user can configure whether he/she wants to import the selected classes into an entirely new ontology (in which case the ontology name and the name of the file to save it to needs to be  
Line 91: Line 127:
  
  
==== Configuring properties to be imported ====
+
=== Configuring properties to be imported ===
  
Apart from the classes, the user might also wish to import various properties of each class, along with their values. However, since the same property might not exist in the local ontology, the user can choose which property of the local ontology to assign it to. Currently, the plugin allows a user to import only the Label, Definitions and Synonyms properties from BioPortal. However, this list might be extended in the future. The figure below depicts how to configure which properties to import for each class, and their equivalent properties in the local ontology.
+
Apart from the classes, the user might also wish to import various properties of each class, along with their values. However, since the same property might not exist in the local ontology, the user can choose which property of the local ontology to assign it to. Currently, the plugin allows a user to import only the ''Label'', ''Definitions'' and ''Synonyms'' properties from BioPortal. However, this list might be extended in the future. The figure below depicts how to configure which properties to import for each class, and their equivalent properties in the local ontology.
  
 +
The properties used for label, definition and synonyms are configured in BioPortal for each individual ontology, and they are read by the plugin using a REST service. If the corresponding properties are already part of the local ontology, then they will be by default selected in the configuration panel (the first option in the radio button).
  
[[File:Configuring_Properties_To_Be_Imported.png]]
+
[[File:Configuring_Properties.png]]
  
== The result ==
 
  
Below is a screenshot that shows the OWLClasses tab, for which we have configured using the steps above, the BioPortalReference widget:
+
=== Configuring the metadata to import ===
  
 +
The user may also specify which metadata to import at class or ontology level in the ''Configuration Panel -> Metadata Tab''. Examples of the metadata to import are: the source ontology name and version, the import author and timestamp, and the BioPortal ontology version Id. By default, no metadata is imported. Below is a screenshot of metadata configuration:
  
[[File:Pizza_with_BPRef.png]]
+
[[File:BP_Imp_metadata_config.png]]
  
= Under the hood =
 
  
The plugin creates instances of the <code>OWLNamedClass</code> class to store all the imported classes from BioPortal. If the user chooses to import any property of the imported classes, it is assigned to one of the <code>OWLAnnotationProperties</code> of the current <code>OWLModel</code>, as configured by the user.
+
== Import example ==
  
To display the list of ontologies in BioPortal, get the details of the classes and their properties etc., the plugin invokes the [http://www.bioontology.org/wiki/index.php/NCBO_REST_services BioPortal Restful Services].
+
The screenshot below shows an example of an import into the ''Body Part'' subtree of the NCI Thesaurus (local ontology) of the ''Brain part'' subtree (first level of children) from the SNOMED-CT.
  
= Download =
+
We have used the following import configuration:
 +
* Import superclass in the local ontology: ''Body Part'' (NCI Thesaurus)
 +
* Import superclass from the source ontology: ''Brain part'' (SNOMED-CT)
 +
* Import also subclasses, set level to import to 1
 +
* Import properties: ''Label'' -> ''Preferred_Name'', ''Definitions'' -> ''DEFINITION'', ''Synonyms'' -> ''Synonym''. (the mapped properties are from the NCI Thesaurus)
 +
* Import class metadata: enabled all checkboxes for the class metadata.
  
The plugin is distributed with the Protege 3.4.2 release and newer. However, we might need to make changes to the plugin to keep in sync with the BioPortal releases. For this reason, we also provide separate downloads for the plugin.
+
Please note that we have also enabled the rendering by the ''Preferred_Name'' property from NCI Thesaurus from the OWL menu -> ''Preferences'' -> ''Rendering''. (See below more explanation on how to set the rendering property.)
  
We have a patch version of the plugin for Protege 3.4.3, that can be downloaded from [http://smi-protege.stanford.edu/collab-protege/tmp/bioportalReference.zip here]. Unzip it into your Protege 3.4.x plugin folder. (Make sure you override the old versions of the plugin.)
 
  
The source code of the plugin is available in our SVN: http://smi-protege.stanford.edu/svn/bioportal-reference-plugin/trunk/ and it is licensed under Mozilla Public License.
+
[[File:Import_Result1.png]]
  
  
= Developer's Guide =
+
'''Note:''' Notice that the highlighted class in the above example, ''Brain part'' (Full id: http://purl.bioontology.org/ontology/SNOMEDCT/119235005) that was imported from the SNOMED-CT ontology into the NCI Thesaurus, is displayed using the value of the ''Preferred_Name'' property. This is much more intuitive than displaying the default full URI of the class. To enable the rendering by a different property (default is the id of the class), go to the ''OWL menu -> Preferences -> Rendering'', and set the value of the ''Render entities in this ontology using property:'' drop-down to whichever property that you want to use to display the class (in this example, we show how to set ''rdfs:label'' as the rendering property).
  
This plugin is very easy to extend.
 
  
== Configure the classpath and Eclipse setup ==
+
[[File:Setting_Render_Property.png]]
  
First, you should get the sources of the plugin from the SVN repository, as explained in the above section. The plugin depends on:
 
* standard-extensions (get the one in the zip from [http://smi-protege.stanford.edu/collab-protege/tmp/bioportalReference.zip here])
 
* protege-owl
 
* xstream libs (get the binary version from [http://xstream.codehaus.org/download.html here], Libs needed in the classpath: xpp3_min_xyz.jar and xstream-xyz.jar)
 
  
If you would like to use Eclipse development environment, we have a guide of how to set it up for plugin development [[SetUpEclipseForPlugin|here]].
+
= Under the hood =
  
== Explanation of classes ==
+
The plugin creates instances of the <code>OWLNamedClass</code> class to store all the imported classes from BioPortal. If the user chooses to import any property of the imported classes, it is assigned to one of the <code>OWLAnnotationProperties</code> of the current <code>OWLModel</code>, as configured by the user.
  
The plugin is very simple. It has classes for UI and classes for accessing BioPortal through rest services.
+
The import metadata properties are defined in the ''provenance.owl'' ontology that is available from [http://protege.stanford.edu/ontologies/metadata/provenance.owl here]. The metadata properties defined in this ontology might change in future versions of the plugin based on the community feedback.
  
The slot plugin class (main UI) is: <code>edu.stanford.bmir.protegex.bp.ref.BioPortalReferenceWidget</code>
+
To display the list of ontologies in BioPortal, get the details of the classes and their properties etc., the plugin invokes the [http://www.bioontology.org/wiki/index.php/NCBO_REST_services BioPortal Restful Services].
  
The panel in which you can search and import from BioPortal is: <code>edu.stanford.bmir.protegex.bp.ref.SearchPanel</code>
 
  
The reference model class that creates the reference instances and makes the actual import is: <code>edu.stanford.bmir.protegex.bp.ref.ReferenceModel</code>
+
= Limitations and known issues =
  
If you would like to change the way that references are imported, change the method (or create your own):
+
The first version of this plugin is distributed with the Protege 3.4.7 release. As with any other plugin, this is work in progress, and we encourage the community to provide us feedback, and even get involved in the development of this plugin.
  
public Instance createReference(String bpBaseUrl, String conceptId, String ontologyVersionId, String preferredName, String ontologyName)
+
Some of the limitations and known issues are:
 +
* It is only possible to import the label, definition and synonym properties for a class. Future versions will allow the selection of arbitrary properties to import.
 +
* While an import is going on, the user interface is blocked, and it is not possible to cancel a long running import. (future enhancement)
 +
* It is not possible to persist an import configuration into a file to reuse for other ontologies. (future enhancements)
 +
* The plugin only works with Protege-OWL, and not with Protege Frames ontologies. If there is enough interest in the community, we will also support Frames.
  
The package <code>org.ncbo.stanford</code> contains the classes that can can invoke a rest service to BioPortal and that can read in the results. All you need to invoke the services is in the <code>org.ncbo.stanford.util</code> package.
 
  
 +
= Download =
  
== Invoke BioPortal Rest services ==
+
The plugin is distributed with the Protege 3.4.7 release and newer Protege 3.x releases. This plugin does not work with Protege 4.x releases. We plan to support this in the future.
  
The BioPortal Rest services are documented [http://www.bioontology.org/wiki/index.php/NCBO_REST_services here].
+
Even if the plugin is distributed with Protege 3.x release, we might need to make changes to the plugin to keep in sync with the BioPortal releases and to add enhancements and bug fixes. For this reason, we also provide separate download for the plugin.
  
For example, to invoke a search in BioPortal, you can use the utility class:
+
We have a patch version of the plugin that can be downloaded from [http://smi-protege.stanford.edu/collab-protege/bioportalReference.zip here]. Unzip it into your Protege 3.x plugin folder. (Make sure you override the old versions of the plugin.)
  
BioportalSearch sd = new BioportalSearch();
+
The plugin is open source and the source code is available in our SVN and it is licensed under Mozilla Public License (MPL).
String urlStr = "http://rest.bioontology.org/bioportal/search/Myocardial%20Infarct?pagesize=20&pagenum=1";
 
try {
 
    Page p = sd.getSearchResults(new URL(urlStr));
 
    SearchResultListBean data = p.getContents();
 
    for (SearchBean searchBean : data.getSearchResultList()) {
 
        System.out.println(searchBean.getPreferredName() + "\t" + searchBean.getOntologyDisplayLabel());
 
    }
 
  } catch (MalformedURLException e) {
 
    e.printStackTrace();
 
  } catch (IOException e) {
 
    e.printStackTrace();
 
  }
 
  
For an example implementation see: <code>edu.stanford.bmir.protegex.bp.ref.SearchPanel.getSearchResultsHtml()</code>
+
To browse the source code from our SVN, please visit: http://smi-protege.stanford.edu/svn/bioportal-reference-plugin/trunk/
  
 +
To check out the sources for the BioPortal Import Plugin, use the following command in a terminal:
  
To get all details of a concept, you can use the following code:
+
<pre>
 +
svn co https://smi-protege.stanford.edu/repos/protege/bioportal-reference-plugin/trunk bioportal-plugin
 +
</pre>
  
BioportalConcept c = new BioportalConcept();
+
The BioPortal import plugin also depends on a generic Java library for accessing BioPortal Web services (the lib is included as a jar file in the lib folder of the previous check out). The sources for this lib are available in:
String urlStr = "http://rest.bioontology.org/bioportal/concepts/39002/BRO:Resource";
 
try {
 
    ClassBean cb = c.getConceptProperties(new URL(urlStr));
 
    System.out.println(cb.getFullId() + " " + cb.getId() + " " + cb.getLabel());
 
    Map<Object, Object> relationsMap = cb.getRelations();
 
    for (Map.Entry<Object, Object> e : relationsMap.entrySet()) {
 
        System.out.println(e.getKey() + ": " + e.getValue());
 
    }
 
  } catch (MalformedURLException e) {
 
        e.printStackTrace();
 
  }
 
  
 +
<pre>
 +
svn co https://smi-protege.stanford.edu/repos/protege/bioportal-services-lib/trunk bioportal-plugin
 +
</pre>
  
 
= Where to get help and complain =
 
= Where to get help and complain =

Latest revision as of 13:34, June 13, 2014

BioPortal Import Plugin

by Jithun Nair, Tania Tudorache

Screenshot

Type Project
Author(s) Jithun Nair, Tania Tudorache
Last Update July 15, 2011
License Mozilla Public License (MPL)
Homepage BioPortal Import Plugin website
For Application
Topic(s)
Affiliation

The BioPortal Import Plugin allows users to import classes from external ontologies stored in the BioPortal ontology repository. The user can import entire trees of classes with a desired depth and choose which properties to import for each class. This plugin works with Protege 3.x releases, not Protege 4.x.

Versions & Compatibility

This section lists available versions of BioPortal Import Plugin.

No version information available.

If you click on the button below to add a new version of BioPortal Import Plugin, you will be asked to define a page title for the new version. Please adhere to the naming convention of BioPortal Import Plugin X.X.X when you define the new page!

Changelog

No version information available.



Overview

As of May 2014, the BioPortal Import plugin does not work anymore.

BioPortal has updated its REST APIs and the plugin has not been ported to the new API, yet. We plan to add this functionality to WebProtege. Follow this GitHub issue for updates.

As a work around for now, you may open the BioPortal ontology directly in Protege 5.x, and edit it (for example, extract branch by deleting the rest of the ontology, or by using the Refactor menu -> Copy/move/delete axioms). To open the BioPortal ontology in Protege 5.x, do these simple steps:

  1. Copy the download link of the ontology from the ontology summary view in BioPortal (e.g., right-click on the link -> Copy link address)
  2. Start Protege 5.x
  3. Go to File menu -> Open from URL, and paste the link in the box

The plugin allows a user to import classes from external ontologies and terminologies stored in the BioPortal ontology repository into the local ontology.

This plugin works with the Protege 3.x releases, not Protege 4.x releases. We plan to have an implementation of this plugin also in Protege 4 as part of the future work. If you are using Protege 4 to develop your ontology, you can still use this plugin by opening the OWL file in Protege 3.x, make the import, save, and then continue to develop the ontology in Protege 4.

The basic steps in using the plugin are to:

  1. browse through the BioPortal ontologies (except remote ones) and select which one to import classes from
  2. select one or more classes to import from the BioPortal ontology,
  3. configure the import,
  4. import them as subclasses of the selected class in the local ontology.


The plugin uses the BioPortal REST services to access and import the content of BioPortal ontologies. However, ontologies denoted as remote in BioPortal cannot be explored in the plugin, since BioPortal does not provide the information for these ontologies through its REST services.

The BioPortal Import plugin is added as a button to the OWL Classes tab of the Protege-OWL 3.x user interface. The user can browse the class tree of the selected BioPortal ontology right from the Protege desktop interface, and also view the properties of each class.


The plugin is configurable and works with Protege-OWL. The import configuration allows the user to customize the import and it includes:

  • import entire subtrees of classes from BioPortal ontologies
  • save the imported classes as a separate ontology and/or as a file to the local disk
  • choose which (if any) property values to import for each class and assign an equivalent user property for each imported property, if desired
  • import metadata at the level of a class or the ontology (e.g. import author, timestamp, source ontology and version, etc.)


A related plugin to this one that allows users to create reference to classes in BioPortal (rather than importing them) is the BioPortal Reference Plugin.


What does it look like

This is a screenshot showing the NCI Thesaurus loaded in Protege, and the SNOMED CT terminology browsed in the BioPortal Import Panel.


BPImportPlugin.png


How to use it

The BioPortal Import plugin can be invoked by selecting a class of a domain ontology in the OWL Classes Tab (that will serve as the superclass of the imported classes), and then clicking on the BioPortal Import icon as shown below:

BioPortal Import Plugin icon.png


Importing classes

In the BioPortal import panel, select a BioPortal ontology from the drop-down list. You may also start typing words from ontology name, and an auto-complete feature will display suggestions.


Select Ontology.png


The plugin will show the class tree of the selected BioPortal ontology in an expandable tree format in the left pane. Selecting one of the classes will show the properties for that class in the details pane on the right hand side. You may select one or more classes to import from the BioPortal ontology.


Select Class.png


Next, configure the import settings by clicking on the 1. Configure Import... button. More details about configuring the settings are provided in the section below.

Once you have configured the import, click on the 2. Import button to import all selected classes into the local ontology in Protege.

Below is an example of the class Brain part (Term ID 119235005) of the SNOMED CT ontology imported as a subclass of Body part class in the NCI Thesaurus ontology.


Imported Classes.png


Import configuration

There are two ways to configure the import process:

  1. Using the menu BioPortal -> Configure..., or
  2. Clicking on 1. Configure Import... at the bottom of the BioPortal import panel.


Importing a subtree of classes

If the user wants to import an entire subtree of classes, the plugin provides an option to enable it, as well as to configure the number of levels down the tree to import, starting from the children of the selected class. This makes it very convenient to import entire parts of an ontology at once.


Importing Subtree.png


Importing into a separate ontology

Often, a user might want to import classes into a separate ontology, which can then be imported into the main ontology. One advantage of this is that the imported classes can be edited and maintained separately. It also makes removing all the imports altogether much easier. If so desired, the user can configure whether he/she wants to import the selected classes into an entirely new ontology (in which case the ontology name and the name of the file to save it to needs to be provided), or as part of an already imported ontology (for which he needs to select from a list of already imported ontologies which are writable).


Importing Into Separate Ontology.png

Importing Into Existing Ontology.png


Configuring properties to be imported

Apart from the classes, the user might also wish to import various properties of each class, along with their values. However, since the same property might not exist in the local ontology, the user can choose which property of the local ontology to assign it to. Currently, the plugin allows a user to import only the Label, Definitions and Synonyms properties from BioPortal. However, this list might be extended in the future. The figure below depicts how to configure which properties to import for each class, and their equivalent properties in the local ontology.

The properties used for label, definition and synonyms are configured in BioPortal for each individual ontology, and they are read by the plugin using a REST service. If the corresponding properties are already part of the local ontology, then they will be by default selected in the configuration panel (the first option in the radio button).

Configuring Properties.png


Configuring the metadata to import

The user may also specify which metadata to import at class or ontology level in the Configuration Panel -> Metadata Tab. Examples of the metadata to import are: the source ontology name and version, the import author and timestamp, and the BioPortal ontology version Id. By default, no metadata is imported. Below is a screenshot of metadata configuration:

BP Imp metadata config.png


Import example

The screenshot below shows an example of an import into the Body Part subtree of the NCI Thesaurus (local ontology) of the Brain part subtree (first level of children) from the SNOMED-CT.

We have used the following import configuration:

  • Import superclass in the local ontology: Body Part (NCI Thesaurus)
  • Import superclass from the source ontology: Brain part (SNOMED-CT)
  • Import also subclasses, set level to import to 1
  • Import properties: Label -> Preferred_Name, Definitions -> DEFINITION, Synonyms -> Synonym. (the mapped properties are from the NCI Thesaurus)
  • Import class metadata: enabled all checkboxes for the class metadata.

Please note that we have also enabled the rendering by the Preferred_Name property from NCI Thesaurus from the OWL menu -> Preferences -> Rendering. (See below more explanation on how to set the rendering property.)


Import Result1.png


Note: Notice that the highlighted class in the above example, Brain part (Full id: http://purl.bioontology.org/ontology/SNOMEDCT/119235005) that was imported from the SNOMED-CT ontology into the NCI Thesaurus, is displayed using the value of the Preferred_Name property. This is much more intuitive than displaying the default full URI of the class. To enable the rendering by a different property (default is the id of the class), go to the OWL menu -> Preferences -> Rendering, and set the value of the Render entities in this ontology using property: drop-down to whichever property that you want to use to display the class (in this example, we show how to set rdfs:label as the rendering property).


Setting Render Property.png


Under the hood

The plugin creates instances of the OWLNamedClass class to store all the imported classes from BioPortal. If the user chooses to import any property of the imported classes, it is assigned to one of the OWLAnnotationProperties of the current OWLModel, as configured by the user.

The import metadata properties are defined in the provenance.owl ontology that is available from here. The metadata properties defined in this ontology might change in future versions of the plugin based on the community feedback.

To display the list of ontologies in BioPortal, get the details of the classes and their properties etc., the plugin invokes the BioPortal Restful Services.


Limitations and known issues

The first version of this plugin is distributed with the Protege 3.4.7 release. As with any other plugin, this is work in progress, and we encourage the community to provide us feedback, and even get involved in the development of this plugin.

Some of the limitations and known issues are:

  • It is only possible to import the label, definition and synonym properties for a class. Future versions will allow the selection of arbitrary properties to import.
  • While an import is going on, the user interface is blocked, and it is not possible to cancel a long running import. (future enhancement)
  • It is not possible to persist an import configuration into a file to reuse for other ontologies. (future enhancements)
  • The plugin only works with Protege-OWL, and not with Protege Frames ontologies. If there is enough interest in the community, we will also support Frames.


Download

The plugin is distributed with the Protege 3.4.7 release and newer Protege 3.x releases. This plugin does not work with Protege 4.x releases. We plan to support this in the future.

Even if the plugin is distributed with Protege 3.x release, we might need to make changes to the plugin to keep in sync with the BioPortal releases and to add enhancements and bug fixes. For this reason, we also provide separate download for the plugin.

We have a patch version of the plugin that can be downloaded from here. Unzip it into your Protege 3.x plugin folder. (Make sure you override the old versions of the plugin.)

The plugin is open source and the source code is available in our SVN and it is licensed under Mozilla Public License (MPL).

To browse the source code from our SVN, please visit: http://smi-protege.stanford.edu/svn/bioportal-reference-plugin/trunk/

To check out the sources for the BioPortal Import Plugin, use the following command in a terminal:

 svn co https://smi-protege.stanford.edu/repos/protege/bioportal-reference-plugin/trunk bioportal-plugin

The BioPortal import plugin also depends on a generic Java library for accessing BioPortal Web services (the lib is included as a jar file in the lib folder of the previous check out). The sources for this lib are available in:

 svn co https://smi-protege.stanford.edu/repos/protege/bioportal-services-lib/trunk bioportal-plugin

Where to get help and complain

If you have any problems with the plugin, please post a message on the protege mailing list (protege-owl for OWL ontologies, and protege-discussion for Protege frames ontologies). Instructions for posting on the lists are here:

http://protege.stanford.edu/community/lists.html

Before posting, please check the email list archives, whether the question has already been answered:

http://protege.stanford.edu/community/archives.html

Thank you!