Difference between revisions of "Running GenMAPP Builder"

Revision as of 16:09, 17 October 2013

This tutorial will take you through all of the steps for running GenMAPP Builder for the first time.

Pre-requisites

This tutorial assumes that you are working in a Windows environment. While it is possible to run GenMAPP Builder under the Mac or Linux OS, the end product, a GenMAPP-compatible Gene Database (.gdb), can only be used with the GenMAPP program, which can only be run on Windows.

To run GenMAPP Builder and perform quality control tests on the resulting GenMAPP Gene Database, you will need to set up your working environment with:

1. Any tool that can unpack .gz and .zip files
   • We use 7-zip
   • Note that we have found that the native Windows utility cannot reliably unpack .gz files or .zip files containing .jar files.
2. PostgreSQL on Windows (http://www.enterprisedb.com/products-services-training/pgdownload)
   • This tutorial was written using PostgreSQL 9.2.4.
3. GenMAPP Builder (https://sourceforge.net/projects/xmlpipedb/files/)
   • Requires 32-bit Java JDK or JRE version 6 or higher (http://java.com/en/download/manual_v6.jsp)
4. GenMAPP 2 (http://genmapp.org)
   • GenMAPP 2 is now called "GenMAPP Classic" and can be downloaded here.
5. XMLPipeDB match utility (https://sourceforge.net/projects/xmlpipedb/files/) for counting IDs in XML files
6. Microsoft Access or any other tool that can read .mdb files

Download and Extract Data Source Files

• Download UniProt XML and GOA files.

UniProt XML

• Go to the UniProt Complete Proteomes page.
  • Browse to the complete proteome download page for your species of interest. For example, to get to Vibrio cholerae page, first click on the link to "List all Bacteria" under the Complete Proteome heading.
  • Click through the results until you get to this page.
  • Click on the link for "complete proteome set" or complete reference set" for the organism of interest, e.g. Vibrio cholerae serotype O1 (strain ATCC 39315 / El Tor Inaba N16961).
  • Click the orange Download link in the upper right-hand corner of the page.
  • Click to download the complete proteome set in XML format (make sure that you are saving it to your local hard drive).
    • Note: you also have the option to download the data in a compressed .gz format. Click on the compressed link at the top of the page and then click to download the complete proteome set.

GOA

• Go to the UniProt-GOA Downloads page.
  • The current and previous UniProt-GOA files can be downloaded from the UniProt-GOA ftp site.
  • In the directory that appears, click the link to the "proteomes" directory.
  • Find your organism of interest and right-click on the link to download the GO annotations and select "Save target as" or "Save link as" and save the GOA file. For example, this is the link for Vibrio cholerae.
    • Note: Since the GOA file is a text file, your browser will not automatically download it when you left-click on the link. Instead, it will try to open the file in your browser window. Since it is a large file, this could take a long time if your internet connection is slow.
    • The version information can be found on displayed in the ftp file directory under the "Last modified" column. It is a good idea to record the version information for "GOA Proteome Sets" and the date they were released as this is your original data source.

GO OBO-XML

• Download the GO OBO-XML formatted file from the Gene Ontology download page. Click on the link for "obo-xml.gz"
  • Note that Gene Ontology has announced that they are making changes to the page listed above and that users should use a beta page here.
  • This file is updated daily, the time used to be stated near the top of the page under "Current ontology statistics" as Pacific Standard Time (PST), although it does not appear to be there right now. You can get the day/time file was created from the file properties after you have unzipped the file.

• Extract the UniProt XML and GO OBO-XML .gz files using 7-zip or other utility.

Create New Database in PostgreSQL

NOTE: if you have already performed this step and want to use GenMAPP Builder functions with a database you previously created in PostgreSQL, you can skip this step.

• Launch pgAdmin III.
• Double-click on PostgreSQL 9.2 (localhost:5432) on the upper left hand side of the window.
  • This is the equivalent of connecting you to the server and you may be asked for a password at this point.
• Right click on "Databases" and Select "New Database..."
• Give the database a name in the "Name" field and click OK.
• Click on your new database name in the treeview on the left.
• Click on the SQL icon in the toolbar at the top of the window.
  • The SQL Editor tab will be open and there may be leftover query text in the upper pane. Delete this text. You are now going to use an XMLPipeDB query to create the tables in the database.
• Click on the Open File icon in the toolbar (the yellow folder with an arrow).
• Navigate to the folder in which you unzipped GenMAPP Builder.
• Open the sql folder and open the file gmbuilder.sql. You should see SQL code appear in the SQL Editor tab.
• Click the Execute Query icon which looks like a green "Play" triangle button.
• You should get a series of NOTICE messages in the Messages tab at the bottom of the window, concluding with a message like "Query returned successfully with no result in 15583 ms" in the end. This query now created all the tables in the database (although there is still no data in them).
• Close the query window (you don't need to save the query because you have already run it).
• To double check that all is OK, click the + sign for the database, then the + sign for Schemas, then finally the + sign for public. Under the Tables section, you should see a count of 159 in parentheses.

Configuring GenMAPP Builder to Connect to your PostgreSQL Database

• Launch gmbuilder.bat (or gmbuilder-32bit.bat)
  • If the program does not detect a database configuration, you will see a message window to this effect and the configuation dialog will open automatically once you close the message window. Otherwise:
• Select the menu item File > Configure Database...
• Under the Database Connections tab the Database Driver defaults to PostgreSQL. Enter information in the following fields:
  • Host or address: localhost
  • Port number: 5432
  • Database name: <enter the name of the PostgreSQL database you created above>
  • Username: <enter the username of the PostgreSQL database you created above>
  • Password: <enter the password of the PostgreSQL database you created above>
• Click the OK button.

Importing Data into the PostgreSQL Database

• Select File > Import UniProt XML...
  • Navigate to the UniProt XML file that you extracted previously and click the Open button.
  • This should take about 5-10 minutes, but may take longer depending on the size of the file, processor speed, and available memory of the machine. When the process has completed, record the elapsed time from the message window that appears.
• Select File > Import GO OBO-XML...
  • Navigate to the GO OBO-XML file that you extracted previously. Click the Open button.
  • This should take about 5-10 minutes, but may take longer depending on the size of the file, processor speed, and available memory of the machine. When the process has completed, record the elapsed time from the message window that appears.
• Click OK to the message asking you to process the GO data.
  • This should take about 5-10 minutes, but may take longer depending on the size of the file, processor speed, and available memory of the machine. When the process has completed, record the elapsed time from the message window that appears.
• Select File > Import GOA...
  • Navigate to the GOA file that you downloaded previously and click the Import button. This process should only take a minute or so.

Exporting a GenMAPP Gene Database (.gdb)

• Select File > Export to GenMAPP Gene Database...
• Type a name in the Owner field (or else it won't let you export).
• Create GenMAPP Database: click on the Specify File button and accept the default folder and file name.
• Select "Move all" for both the upper and lower panels. Click Next.
• A window will ask you to verify the system tables. Clicking Next in this window starts the import process.
  • Record the starting and ending times from the black console window. This will take 1-2 hours for a typical bacterial genome, depending on the size of the database, the processor speed, and available memory. Large eukaryotic genomes (like Arabidopsis thaliana) or genomes with many GO annotations (like Saccharomyces cerevisiae) can take much longer, in the range of 12-24 hours. NOTE: the progress bar is not accurate.

Checking the Quality of your Exported Gene Database

• It is a good idea to check the quality of your exported Gene Database to make sure that all of the data from the XML files made it into the PostgreSQL database and was then exported to the GenMAPP Gene Database. We have created a Gene Database Testing Template to help guide you through this process.