- Barsnes H and Vaudel M: SearchGUI: a highly adaptable common interface for proteomics search and de novo engines. [PMID 29774740] [pdf (accepted version)] [Request a reprint].
- Vaudel M, Barsnes H, Berven FS, Sickmann A, Martens L: SearchGUI: An open-source graphical user interface for simultaneous OMSSA and X!Tandem searches. [PMID 21337703] [pdf (accepted version)] [Request a reprint].
- If you use SearchGUI as part of a publication, please refer to the most recent publication.
|v3.3.20 - Windows||ReleaseNotes|
|v3.3.20 - Mac and Linux||ReleaseNotes|
(Click on figure to see the full size version)
SearchGUI is a highly adaptable open-source common interface for configuring and running proteomics search and de novo engines, currently supporting X! Tandem, MS-GF+, MS Amanda, MyriMatch, Comet, Tide, Andromeda, OMSSA, Novor and DirecTag. It can be used in command line mode or via a user-friendly graphical interface.
To start using SearchGUI, unzip the downloaded file, and double-click the
SearchGUI-X.Y.Z.jar file. No additional installation required!
To visualize and analyze the search results we recommend PeptideShaker.
For developer access to the search results we recommend the use of compomics-utilities.
- From the Command Line
- Database Help
- User Defined Modifications
- Converting Spectrum Data
- Result Analysis
To start identifying peptides and proteins using SearchGUI, download the latest version, unzip the downloaded file, and double-click on the SearchGUI-X.Y.Z.jar file.
From the Command Line
The main purpose of SearchGUI is to make it simpler to use multiple search engines at the same time. A graphical user interface is the best choice for smaller projects. SearchGUI can also be used via the command line, and be incorporated in different analysis pipelines.
For details about the command line see: SearchCLI.
You can install SearchGUI with:
conda install -c conda-forge -c bioconda searchgui
docker run quay.io/biocontainers/searchgui:X.Y.Z--1 searchgui eu.isas.searchgui.cmd.IdentificationParametersCLI
Replace X.Y.Z with the wanted SearchGUI version number.
You need to have in mind that Docker images don’t contain your data into them. If you want to use any data file into a dockerised tool, you will need to map (using
-v Docker parameter) your local folder containing it into the Docker internal file system, like
docker run -v /home/my_user/resources:/myresources quay.io/biocontainers/searchgui:X.Y.Z--1 searchgui eu.isas.searchgui.cmd.IdentificationParametersCLI -out myresources/parameters_output -db /myresources/uniprot-human-reviewed.fasta
In this example we are also writing the ouput of the command (
-out parameter) into the mapped folder in order to write it into our own file system (instead on Docker’s container one) and have access to it from our computer after the execution.
eb -S SearchGUI-X.Y.Z-Java-1.8.0_152.eb module load SearchGUI/X.Y.Z-Java-1.8.0_152
Replace X.Y.Z with the wanted SearchGUI version number.
The easyconfig provides aliases for the common CLI commands:
SearchCLI PathSettingsCLI FastaCLI IdentificationParametersCLI
User Defined Modifications
It is straightforward to add/edit modifications via the graphical user interface. Modifications will be available in other instances of SearchGUI and PeptideShaker for the same user/computer. Not all modifications are correctly handled by the search engines. For example, X! Tandem is not compatible with modifications at termini on specific amino acids. Using such a modification will result in nonsense matches which can be filtered out afterwards. This functionality is available by default in PeptideShaker.
Converting Spectrum Data
SearchGUI supports mgf files as the direct input format for the spectra as this is what is supported by all the search engines.
Note that this option is only available via the graphical user interface. From the command line you have to run the msconvert command line separatelty.
To visualize and analyze the SearchGUI results we recommend the use of PeptideShaker. PeptideShaker is a search engine independent platform for visualization of peptide and protein identification results from multiple search engines.
Issues, Questions and Bug Reports
Code of Conduct
Despite our efforts at enforcing good practices in our work, like every software, SearchGUI might crash, fail to cover specific use cases, not perform as well as expected. We apologize for any inconvenience and will try to fix things to the best of our capabilities. We welcome bug reports, suggestions of improvements, and contributions via our issue tracker.
Does Not Start I - Do you 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 SearchGUI.)
Does Not Start II - Have you unzipped the zip file? You need to unzip the file before double clicking the jar file. If you get the message “A Java Exception has occurred”, you are most likely trying to run SearchGUI from within the zip file. Unzip the file and try again.
Does Not Start III - Is SearchGUI installed in a path containing special characters, i.e.
%, æ, ø, å, etc? If so, move the whole folder to a different location or rename the folder(s) causing the problem and try again. (Note that on Linux SearchGUI has to be run from a path not containing spaces).
Unidentified Developer - If you run SearchGUI on a Mac you can get the warning “SearchGUI” can’t be opened because it is from an unidentified developer. To escape this warning control-click on the file icon and then select “Open.” This will give you the option of opening it regardless of its unidentified source. This only has to be done once for each SearchGUI version.
Search Engine Issues - Important: If you have problems with the search engines, please verify that the search engines are working outside of SearchGUI first. To test your installation run the search engine executable on the command line. This should result in output describing what the script does. If you get this, it works, and SearchGUI should run without problems. If not, see below.
X! Tandem XML Syntax Error - If X! Tandem gives the error “Syntax error parsing XML”, the problems is most likely that the path to your database or mgf files contains special characters not supported on your operating system. If this happens try renaming the folders containing the special characters or move the files to folders not containing special characters.
Linux Support - Users wanting to use SearchGUI on Linux may have to install the search engines first, see the tools web pages for available search engine versions. Important: Please verify that the search engines are working outside of SearchGUI before using them inside SearchGUI.
Linux Support II - If you get problems running makeblastdb (need to prepare FASTA files for OMSSA searches) make sure that you have the required 32 bit libraries. To install the libraries you can use “sudo apt-get install ia32-libs”.
MS Amanda Log - If you encounter problems with MS Amanda it may help to inspect the MS Amanda log files. On Windows these are located here:
MS Amanda on Linux - Running MS Amanda on Linux requires that you have Mono installed. Mono 3.2.1 or newer is required and the libmono-system-core4.0-cil has to be installed. To check your Mono version run “mono -V”. Mono can be installed as follows: “sudo apt-get install mono-runtime” (and if needed “sudo apt-get install libmono-system-core4.0-cil” and “sudo apt-get -f”). For some Linux distributions Mono version 3.X is not directly available, you might be able to use: “sudo add-apt-repository ppa:directhex/monoxide”, “sudo apt-get update” and “sudo apt-get dist-upgrade”. For more help on installing Mono please see http://www.mono-project.com/download.
MyriMatch on Linux - If you get the error “
locale::facet::_S_create_c_locale name not valid”, this can be fixed by running the command “export LC_ALL=C” before running SearchGUI/MyriMatch. To make this fix permanent, put the export line in your .bash_profile (~/.bash_profile). If you still have problems, please contact the MyriMatch developers.
Linux and Mac OSX File Permissions - On Linux and Mac OSX you may have to edit the permissions for the executable files in order for SearchGUI to work. Allow execution for all users.
32 bits vs 64 bits - Please make sure that your using versions of the search engines that are compatible with your OS. Note that the latest releases of OMSSA are only available in 64 bits versions. For older versions of OMSSA see the OMSSA archive. However, it is always recommended to use the latest version if possible. Also note that OMSSA versions up until version 2.1.9 does not support precursor mass tolerance in ppm.
Xlib/X11 errorrs - When running the command lines on systems without a grahpical user interface you may get errors related to X11. If that happens try adding
-Djava.awt.headless=trueto the command line.
Problem Not Solved? Or Problem Not List? - Contact the developers of SearchGUI by setting up an issue describing the problem. If the issue is related to the installation of the search engines, please contact the search engine developers directly.