View source for RadLex Protege Plugin

== Plugin Description ==
The plugins have been tested on version 3.2 of [http://protege.stanford.edu/ Protege].  If the plugins do not work on a newer version, it is recommended that the plugin is rebuilt from source, using the most recent build of the Protege libraries.


=== Tabbed File Importer === 
Imports the parent/child relationships based upon a tabbed file.  The RadLex Committees have created Microsoft Word files that contain the basic structure and definition of terms.  Each file is constructed so that an indent past the current indentation level indicates a child of the higher term.  Terms on the same level are considered to be siblings.  Additional codes are put at the beginning of the lines to indicate the type of relationship.  Synonyms, definitions, and comments are added to the end of the line, following special codes.

==== Sample Tabbed File ====
The following is a small portion of the thorax file.
<pre>
ISA:	thorax; chest [COM: child of anatomic location]
CON:		airway
P:			tracheobronchial tree  
				trachea   
					carina   
BR:				bronchus   
					right main bronchus 
						right upper lobe bronchus
</pre>

==== Format of Tabbed Files ====
MSWord files must be indented using true tab characters, not margin changes.  This can be 
accomplished in MSWord under Tools > AutoCorrect Options... > Auto Format As You Type, and uncheck
the box labeled "Set left- and first-indent with tabs and backspaces" (2nd from bottom).
 
The relation between parent and child terms can be switched using by placing the code for each 
relation at the beginning of the line, followed by ":".  The relation persists until changed by
another code.  The codes are listed in the comment [COM:] fields of the attached file 
"RadLexRelations.doc".  It is relatively easy to add new relations if needed.

Protégé slots for each term can be specified using information in square brackets following a term 
on the same line.  A code within the square brackets signifies the slot to be filled.  For example: 
[COM: This is a comment.] [DEF: This is a definition.].  It is easy to create new codes to signify 
new term attributes.

Synonyms are listed on the same line, separated by semicolons.  The first term on the line is the
primary term.

==== Codes ====
<table  border="1">
<tr>
<th>Code</th>
<th>Relationship</th>
<th>Comment</th>
</tr>
<tr>
<td>ISA</td>
<td>Is a</td>
<td>Type of</td>
</tr>
<tr>
<td>P</td>
<td>Part of</td>
<td></td>
</tr>
<tr>
<td>BR</td>
<td>Branch of</td>
<td>vessel, nerve</td>
</tr>
<tr>
<td>SEG</td>
<td>Segment of</td>
<td></td>
</tr>
<tr>
<td>TRIB</td>
<td>Tributary of</td>
<td>Vein, nerve plexus, arterial confluence</td>
</tr>
<tr>
<td>CON</td>
<td>Continuous with</td>
<td></td>
</tr>
<tr>
<td>C</td>
<td>Contained in</td>
<td></td>
</tr>
<tr>
<td>MEM</td>
<td>Member of</td>
<td></td>
</tr>
</table>


<table border="1">
<tr>
<th>Code</th>
<th>Field</th>
</tr>
<tr>
<td>DEF</td>
<td>Definition</td>
</tr>
<tr>
<td>COM</td>
<td>Comment</td>
</tr>
</table>


==== How to Import a Tabbed File ====
First, make sure that the RadLex Import tab is visible in Protege.  If not, add it by going to the Project > Configure menu and checking the "RadlexImportTab".

Now go to the "Radlex Import Tool" tab.  On the left, click the term under which the file should be added.  The click the "import File..." button and select the file that you wish to import (NOTE: the file must be a plain text file, Word files and RTF files are not acceptable).

The importer will check to make sure that there are no terms with the same name.  If all term names are 
unique, it will generate a unique RadLex ID and add the terms to the ontology.



=== RadLex SQL Exporter === 
Generates a file for creating the database for the [http://radlex.org RadLex Term Browser].  This plugin can be launched from the File > Export Menu (assuming the RadLex Plugins have been installed. For more information on the table structure and design rationale, see the [[RadLex SQL Database]] page.

=== RadLex OWL Exporter === 
converts the Protege Frames ontology into a OWL ontology


=== RID Generator === 
generates unique RadLex ID for new terms 


== Installation Instructions ==
Download and install [http://protege.stanford.edu/ Protege].

Download a copy of the plugin.

Unzip the plugin into the plugins directory of your Protege installation.  On windows, this directory usually is (depending on your version of Protege):
<pre>C:\Program Files\Protege_3.2.1\plugins</pre>
Once unzipped, the file plugin will be located at 
<pre>C:\Program Files\Protege_3.2.1\plugins\org.radlex\radlex_plugins.jar</pre>


[[Category: RadLex]]