BioPortal 2.3 Release Notes

From NCBO Wiki
Jump to navigation Jump to search

New features

  • BioPortal will process SKOS labels for preferred names and synonyms:
  • Ontologies used by Annotator & Hierarchy services will now be updated on a regular basis (around every week).
  • The filtering of annotation by semantic types is available only for the ontologies which provide that information
  • The Annotator scoring function has changed a bit.
  • Users can now exclude the annotations created with synonym terms.
  • Users can now exclude the annotations less than a certain length.
  • There is a change in the concept XML returned by the Annotator service. Please note that the <semanticTypeBean> information is presented differently in <concept>. The Get all terms REST service is also affected.
<concept>
        <id>2357621</id>
        <localConceptId>40399/CDR0000038833</localConceptId>
        <localOntologyId>40399</localOntologyId>
        <isTopLevel>0</isTopLevel>
        <preferredName>melanoma</preferredName>
        <synonyms>
                <string>Skin cancer, melanoma</string>
                <string>melanoma, cutaneous</string>
                <string>cutaneous melanoma</string>
        </synonyms>
        <semanticTypes>
                <semanticTypeBean>
                        <id>3410411</id>
                        <semanticType>T191</semanticType>
                        <description>Neoplastic Process</description>
                </semanticTypeBean>
                <semanticTypeBean>
                        <id>3410007</id>
                        <semanticType>T999</semanticType>
                        <description>NCBO BioPortal concept</description>
                </semanticTypeBean>
        </semanticTypes>
</concept>
  • There is a change in the mapping context XML returned by the Annotator service. <term>, <from>, <to> information has been added.
<context class="mappingContextBean">
        <contextName>MAPPING</contextName>
        <isDirect>false</isDirect>
        <term>
                <name>Melanoma</name>
                <localConceptId>42331/Melanoma</localConceptId>
                <isPreferred>1</isPreferred>
                <dictionaryId>3</dictionaryId>
        </term>
        <from>1</from>
        <to>8</to>
        <mappedConceptId>42331/Melanoma</mappedConceptId>
        <mappingType>Automatic</mappingType>
</context>


  • There is a change in the XML returned by the /obs/ontologies service. The ontologyBean now includes the following output:
<ontologyBean>
	<id>3</id> 
	<localOntologyId>40571</localOntologyId> 
	<name>Electrocardiography Ontology</name> 
	<version>0.1.5</version> 
	<description /> 
	<status>28</status> 
	<virtualOntologyId>1146</virtualOntologyId> 
	<format>OWL</format> 
</ontologyBean>
  • There is a change in the XML returned by the /obs/semanticTypes service. The semanticTypeBean now includes the following output:
<semanticTypeBean>
	<id>1</id> 
	<semanticType>T000</semanticType> 
	<description>UMLS concept</description> 
</semanticTypeBean>


Please refer to http://www.bioontology.org/wiki/index.php/Annotator_User_Guide for details on Annotator enhancements

New way to address UMLS ontologies

We have harmonized the ontologies in the Annotator and BioPortal. The full list is available at: http://rest.bioontology.org/obs/ontologies. This change has implications when using the Annotator with UMLS ontologies.

  • Currently, BioPortal (and, therefore, Annotator and Hierarchy services) can use 16 ontologies from UMLS. We will add UMLS ontologies to BioPortal on demand. Please send email to support@bioontology.org to request a specific UMLS ontology to be added to BioPortal.
  • UMLS SAB is no longer valid as ontologyId. Please refer to http://bioportal.bioontology.org/ontologies/?filter=UMLS to map your SAB to the corresponding ontology version id.
  • UMLS CUIs are no longer valid as conceptId. You can look up the conceptId corresponding to a CUI by using the NCBO search interface (http://bioportal.bioontology.org/search): type in the CUI and check "Include attributes in search". You can also use the search REST service (http://www.bioontology.org/wiki/index.php/BioPortal_REST_services#Search_services) to search for the concept by CUI. We are working on a new concept service that will accept CUI as conceptId in the near future.

Known issues

  • ISA closure in the Annotator and Hierarchy services do not work properly for NCIT and Galen. This will be fixed in an upcoming release.
  • Some mappings present in BioPortal are not yet available for use with the Annotator.

Other features and bug fixes

  • Implemented updates to Hierarchy (OBS Wrapper) Services to conform to the new OBS output XML structure
  • Added case sensitivity check for the root concept (per #1793)
  • Upgraded the deprecated Acegi Security to Spring Security
  • Implemented support for OpenID Authentication
  • New lexbig JAR intended to fix the problem with the graph not focused properly when there are 2 ontologies with the same uri.(Bioportal bug #1783)

BioPortal UI Internal Features and Bugfixes

  • Fixed bug in autocomplete drop-downs where they could not distinguish between two ontologies or concepts with the same name.
  • New functionality to display messages on the front page with a close button that remembers that users closed the message. Set $FRONT_NOTICE in environment.rb to your desired message in order to display a message.
  • Updated language on error messages when attempting to browse individuals/properties.
  • Fixed a bug where submiting a remote ontology would trigger an exception because the app was looking for an uploaded file.
  • Fixed a bug in URI generation for resources where fixnums were being interpreted as strings without conversion.
  • Added a custom logging framework to enable logging to the BioPortal Core.
  • Added functionality to hide explore and download links using a global array. This fix is temporary until this information is stored in the ontology metadata.
  • A custom Google Analytics ID can now be provided via the environment.rb file.
  • If metrics don't exist, the UI now checks prior versions (back through 21 versions, three weeks for ontologies that are updated daily). The user is informed that the metrics are from a previous version and given a link to that version.
  • When registering a new account, a check is now made to make sure that the username doesn't already exist.
  • Before displaying a link for downloading diffs, the UI now makes sure that the diff is between that ontology and the prior existing ontology. This is to handle cases where an ontology may have been deleted but the record of a diff still exists. (Bug #1389)
  • Somehow sorting was removed from the resources on the Resource Index tab. This has been re-enabled.
  • Extending the slider on the ontology visualization page now works properly in IE (Bug #1500)
  • The BioPortal UI is now using the REST service to gather its list of Groups and related ontologies. In addition, Groups have been added to the ontology summary page. (Bug #1607)
  • Fixed a bug where visiting the "Submit new ontology" link on the Browse page while logged out didn't redirect properly once a user logged in (Bug #1486).
  • Removed extra characters from search fields on the BioPortal index page (Bug #1390)
  • Refactored much of the code in the DataAccess class to implement a common method to store/retrieve objects from the cache and make calls to the BioPortal Core when objects aren't in the cache.
  • Exception handling for IO errors due to calls to the back-end that could not be completed. Generally these were improper or unknown concept ids being passed by GoogleBot, but there were some genuine errors that weren't being handled. The user is now informed, via a very basic error message, when a concept can't be found in an existing ontology.
  • Added a REST_DOMAIN config option so that we could pass this parameter to Flex apps and have them use the appropriate locations for REST services. Prior to this the Flex apps were hard-coded to use production for many parts of their operation.
  • Added a FLEX_URL config option to allow for hosting of Flex apps in different locations.