Skip to content

compomics/pride-converter

BranchesTags

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

229 Commits

pride_converter

pride_converter

 
 

README.md

README.md

 
 

Repository files navigation

This project is out-dated and we strongly recommend to use the newer PRIDE Converter 2.

Input formats, not supported by PRIDE Converter 2, for instance ms_lims, SEQUEST Result Files and Spectrum Mill can be still be converted by the old converter, referred to simply as PRIDE Converter at the current page.

You can also try PeptideShaker which has as built-in PRIDE XML exporter.

PRIDE Converter

PRIDE Converter Publications:

About PRIDE Converter

PRIDE Converter converts mass spectrometry data from most common data formats into valid PRIDE XML for submission to the publicly available PRIDE database. It presents a convenient, wizard-like graphical user interface, and includes efficient access to the Ontology Lookup Service (OLS).

The currently supported formats are:

Mascot Dat Files Mascot Generic Files X!Tandem mzData
ms_lims 7 Spectrum Mill Micromass PKL Files PeptideProphet/ProteinProphet
Sequest Result Files Sequest DTA Files mzXML OMSSA
VEMS PKX Files MS2 Files DTASelect (beta)

Remarks:

  • Support for additional formats is in development.
  • Requests for additional formats can be sent to the PRIDE team.
  • Please note that not all of the supported formats are equally well documented. If you come across files that are of the supported formats, but for some reason fails to be converted, or if you detect errors with the conversion, please let us know so that we can try to fix the problem.

PRIDE Converter was developed by Harald Barsnes (when a PhD student at the University of Bergen) under the guidance of Dr. Lennart Martens (EBI). As of July 2009 the development of PRIDE Converter was turned over to the PRIDE team at the EBI. To contact the team see the Support section.

If you use PRIDE Converter to publish your data as part of a paper, please include a reference to the PRIDE Converter paper: Barsnes et. al: Nat Biotechnol. 2009 Jul;27(7):598-9. See the How to Reference PRIDE Submissions section.

Go to top of page

Getting PRIDE Converter

Requirements

  • PRIDE Converter requires Java 1.5 (or above), which you can download for free here. Most modern computers will have Java installed already, so first try to follow the instructions below to download and run PRIDE Converter before downloading Java. You only need the JRE version (and not the JDK version) to run PRIDE Converter.

  • Unless your data is stored in, or can be converted to, one of the supported data formats, the software will unfortunately not be of much help. We are however working on extending the list of supported data formats.

  • The current version has been tested on Windows XP, Windows Vista, Linux and Mac OS X, but should also work on other platforms. If you come across problems on your platform please let us know.

Go to top of page

Downloading

You can download the latest version here. Unzipping the file, creates the following directory structure:

  PRIDE_Converter_vX.Y
     PRIDEConverter-X.Y.jar
     Properties
          Contacts
          Instruments
          Protocols
          Samples
     lib

To start the software, simply double-click the file named PRIDEConverter-X.Y.jar. If this fails, try to download and install Java 1.5 or above, as explained in the previous section. (The program can also be started from the command line using the following command: java -jar PRIDEConverter-X.Y.jar.) A PRIDE Converter icon that can be used for shortcuts linking to the program is also included in the zip file.

At start up you will be given the choice of importing the settings from any previously installed versions of PRIDE Converter. Simply follow the instructions to import your old settings and lists of instruments, contacts etc. Upgrading does not delete your previous installation, but when you have verified that you can run the new version without problems, you can manually remove the old version by deleting the given folders.

Go to top of page

Troubleshooting

  • Does Not Start - If nothing happens when double clicking the PRIDE Converter jar file, the most likely cause is that you don't have Java installed. Download the latest version of Java here and try again. (You only need the JRE version (and not the JDK version) to run PRIDE Converter.)

  • Does Not Start II - If PRIDE Converter fails during start-up and you get the "PRIDE Converter - Startup Failed" message, a file called pride_converter.log will be created in your home directory. In this file you will find detailed information about why the program was not able to start.

  • Does Not Start III - The most likely reason for the "PRIDE Converter - Startup Failed" message is that you have installed PRIDE Converter in a path containing special characters, i.e. [, %, æ, ø, å, etc. Move the converter to a different folder or rename the folder(s) causing the problem and try again. (On Linux PRIDE Converter also has to be run from a path not containing spaces).

  • Does Not Start IV - Another reason for the "PRIDE Converter - Startup Failed" message could be that you have set the upper memory limit higher than your computer can handle (see points below).

  • General Error Diagnosis - In the Properties folder (see section above for the folder structure), there is a file called ErrorLog.txt. This file contains transcripts of any errors that the application has encountered, and can be very useful in diagnosing your problem.

  • Memory Issues I - Big datasets can require a lot of memory. If the software unexpectedly fails on a big project, and the software mentions that it ran out of memory, you should try to give the program more memory. This can be done by editing the JavaOptions.txt file in the Properties folder (see section above for the folder structure). In this file, change the -Xmx768M option to a higher number (e.g., -Xmx1500M for a maximum of appr. 1.5GB of memory). Please note that on a 32-bit operating system you can not increase this value beyond 2000M. If increasing the memory settings does not solve your problem, or you don't enough memory available, e-mail a support request to the PRIDE team at the EBI: pride-support at ebi.ac.uk (replace at with @).

  • Memory Issues II - Another memory related issue that can occur in rare cases is that the default Java stack size memory is not set high enough for a given dataset. If this happens an exception will be thrown and an error (java.lang.StackOverflowError) can be found in the ErrorLog.txt file. The solution is to increase the default stack size, which is done in the same manner as the point above, but this time by increasing the -Xss1M and -Xoss1M parameters. Try doubling both of the values until the problem disappears.

  • Memory Issues III - If you get an out of memory error after using the converter to create multiple PRIDE XML files, it might help restarting the converter and try converting the last file again. If the problem persists try increasing the provided memory size as explained above.

  • Memory Issues IV - In some rare cases increasing the maximum memory size may result in the converter not starting, even though you have more than enough memory available. (Please note that on a 32-bit operating system you cannot increase the maximum memory beyond 2000M.) If you are using Windows it may help to increase the available virtual memory, but this is not recommended unless all other options have been tried. For Windows XP: Control Panel -> System -> Advanced Tab -> Performance Panel, Settings -> Advanced Tab -> Virtual memory, Change.

  • Internet Connection - If you have problems connecting to the Ontology Lookup Service, first make sure that you are connected to the internet. Then check your firewall (and proxy) settings to see if they prevent PRIDE Converter from accessing the internet. If you are using a proxy server you need to add the proxy settings to the JavaOptions.txt file in the Properties folder (see section above for the folder structure). Add: "-Dhttp.proxyHost=my.proxy.domain.com" and "-Dhttp.proxyPort=3128" to the end of this file (on two separate lines). Replace the name of the proxy host (and the proxy port if necessary), save the JavaOptions.txt file and start the converter again. If this does not solve your problem, or you are not using a proxy server, you (or your IT department) has to allow HTTP POST connections to the following URL: http://www.ebi.ac.uk/ontology-lookup/services/OntologyQuery.

  • Miscellaneous - A rare issue/bug is that the converter sometimes (for unknown reasons and very rarely) halts after clicking the Convert! button in the last step. If this happens simply cancel the conversion by closing the progress dialog and restart the conversion. If the problem persists, try going back one step in the converter and then forward again before restarting the conversion.

  • Problem Not Solved? Or Problem Not In List Above? - See Support.

Go to top of page

Upgrading

When a new version of PRIDE Converter becomes available, existing users will be notified of this the next time they start the converter. Upgrading is done by downloading the latest version from the PRIDE Converter web pages, unzipping the file in a (preferably) empty folder, and then double clicking on the PRIDE_Converter_vX.Y.jar file. You will then get the chance to import your settings (instruments, contacts, etc) from the previously installed version of the converter. Simply follow the instructions to import all your old settings. Upgrading does not delete the older version of PRIDE Converter. But after making sure that the new version is working, you can safely delete the folder containing the old version.

Installing the new version in the same folder as the previously installed version can result in problems and is not recommended.

A detailed overview of the changes between each PRIDE Converter version can be found in the Release Notes.

Go to top of page

How to Submit Data to PRIDE

Once the PRIDE XML file is created, there are currently two ways of submitting it to PRIDE:

  • Direct submission via the PRIDE web page: this submission path is only suitable for small submissions (files of up to 15 MB unzipped, corresponding to about 5 MB for zipped files). In order to make the submission, users will have to be registered in the PRIDE system and log-in, at which point a “Submit Data” option is made available in the left menu on the PRIDE website.
  • For larger files, users are advised to first contact the PRIDE team at pride-support at ebi.ac.uk (replace at with @). A curator will then create a private directory for the user in the EBI FTP server and the user will be able to upload their files there confidentially.

The restrictions on using the web interface are solely the result of potential problems in the HTTP protocol when uploading large files, as file size limitations are essentially non-existent for submission purposes.

Go to top of page

How to Reference PRIDE Submissions

Referencing PRIDE submissions in manuscripts:

  • If still under some form of review:
    • The data is available in the PRIDE database [ref Vizcaíno et al 2010 (PMID: 19906717)] (www.ebi.ac.uk/pride) under accession numbers X and Y (username: reviewXYZ, password: ABC). The data was converted using PRIDE Converter [ref Barsnes et al 2009 (PMID: 19587657)] (http://pride-converter.googlecode.com).
  • If at galley proof stage:
    • The data is available in the PRIDE database [ref Vizcaíno et al 2010 (PMID: 19906717)] (www.ebi.ac.uk/pride) under accession numbers X and Y. The data was converted using PRIDE Converter [ref Barsnes et al 2009 (PMID: 19587657)] (http://pride-converter.googlecode.com).

Remember to notify the PRIDE team when your paper has been accepted, so that private data (if any) can be made public.

Go to top of page

Getting Help

For questions or additional help, please contact the authors or e-mail a support request to the PRIDE team at the EBI: pride-support at ebi.ac.uk (replace at with @). If appropriate please include a (preferably zipped) copy of the ErrorLog.txt file from the Properties folder (see section above for the folder structure).

Go to top of page

Source Code

PRIDE Converter has mainly been developed using NetBeans, and is built and deployed using Maven.

PRIDE Converter uses code from 10 other projects:

Go to top of page

Screenshots

(Click on a screenshot to see the full size version)

Go to top of page

About

Data conversion tool for creating PRIDE XML

Resources

Readme
Activity
Custom properties

Stars

0 stars

Watchers

17 watching

Forks

1 fork
Report repository

Contributors 4

  •  
  •  
  •  
  •  

Languages