Skip to content
This repository was archived by the owner on Sep 23, 2026. It is now read-only.
neelyPublic archive
forked from jspaezp/sagegui

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

 
 

Repository files navigation

This repository has moved to usnistgov/sagegui. SageGUI is now maintained there, as the NIST fork of jspaezp/sagegui. Releases continue there, tagged nist-vX.Y.Z. This repository's releases v0.6.0 to v0.9.0 are there as nist-v0.6.0 to nist-v0.9.0, with the same binaries. This repository is archived and read-only.

SageGUI

A graphical interface for Sage, the proteomics search engine by Michael Lazear. Unofficial; not affiliated with the Sage project.

Based on the original sagegui by Sebastian Paez.

Sage Version Build Status Release

SageGUI Logo

What it does

SageGUI lets you configure and run Sage searches without the command line. Pick your mzML files and FASTA databases, set search parameters, and hit Run. Results land wherever you point the output directory.

Sebastian's original GUI was pinned to a stale Sage fork. This fork updates it to Sage v0.15.0-beta.2 and keeps it current.

Features

  • Multiple FASTA files (target + contaminants + spike-ins), concatenated automatically at search time
  • Six tabs: Experiment, Files & Database, Search, Modifications, Quant, Run/Info
  • Run bar pinned at the bottom so you can launch from any tab
  • Modifications picker with a curated preset list (Static and Variable boxes, Mascot-style)
  • Enzyme presets: 14 curated proteases, including the Asp-N and Lys-N cases that cut before their residue
  • TMT (6/10/11/16/18-plex) and LFQ quantification
  • Database prefiltering (chunked FASTA processing) to bound peak memory on semi-enzymatic and non-specific searches
  • Settings remembered between sessions (parameters, file picks, active tab, and modifications)
  • Starting templates on the Experiment tab (tryptic wide MS1/tight MS2, tight, open, biofluid, TMT 11-plex)
  • Load search parameters from any Sage config.json or a past run's results.json
  • Tolerance windows entered as a delta-mass range, so a +500 Da modification is set as +500
  • Stop button — cancels a run, including one already scoring spectra
  • Search output: write a Percolator .pin file, an HTML QC report, or per-fragment match detail alongside the results
  • Convert results to mzIdentML 1.1.1 and pepXML 1.23 from the Run / Info tab, for any earlier run or automatically after a search. Choose the q-value (spectrum, peptide or protein), the limit and whether to keep decoys
  • Builds for Windows, macOS (Intel + Apple Silicon), and Linux

To be added

  • Export options: Perseus-format (for Perseus/ProteoPlotter), DIAgui, LFQ-Analyst/FragPipe-Analyst/*-Analyst, Scaffold (?). PDV and MSstats are covered under Downstream tools instead: both read Sage output directly, so no exporter is needed here.
  • iBAQ and other LFQ options

Download

Get the latest release from the Releases page:

Platform Download
Windows (x64) sage-launcher-windows-x64.exe.zip
Linux (x64) sage-launcher-linux-x64.tar.gz
macOS (Intel) sage-launcher-macos-x64.zip
macOS (Apple Silicon) sage-launcher-macos-arm64.zip

macOS: the archive contains Sage Launcher.app. The app is not notarized by Apple, so after you download it macOS refuses to open it with "Sage Launcher.app is damaged and can't be opened." The app is not actually damaged. Unzip it, then run this once in Terminal from the folder containing the app:

xattr -dr com.apple.quarantine "Sage Launcher.app"

Then open it normally. Right-clicking and choosing Open does not work for this message. If you clicked Move to Trash, open the Trash in Finder, right-click the app and choose Put Back, or download it again.

Quick start

  1. Download and extract the archive for your platform
  2. Run sagegui.exe (Windows), double-click Sage Launcher.app (macOS), or run ./sagegui (Linux)
  3. On the Files & Database tab, click "Add FASTA..." and add your database(s), then "Pick mzML files"
  4. Adjust search parameters on the Search, Modifications, and Quant tabs if needed
  5. Click Run at the bottom of any tab

Output goes to the directory set on the Run/Info tab (defaults to the working directory).

Building from source

Requires Rust 1.70+:

git clone https://github.com/neely/sagegui.git
cd sagegui
cargo build --release

Binary is at target/release/sagegui (or sagegui.exe on Windows).

Related

  • Sage — the search engine
  • sageRecon — reconnaissance for unfamiliar data: detects modifications and recommends mass tolerances before a production search

Downstream tools

Tools that read what SageGUI produces. This list grows as support lands.

  • PDV — spectrum and PSM viewer. Sage support arrived in v2.7.0: open results.sage.tsv in the Database Searching dialog together with the mzML or mgf files the search used. Gzipped spectrum files work, and decoys and hits above 1% q-value can be filtered on import.
  • MSstats — statistical analysis. A Sage converter is in development and will read lfq.tsv, which carries the MS1 areas MSstats wants. If you plan to use it, turn off Combine Charge States on the Quant tab. With it on, which is the default, Sage writes a charge of -1 and PrecursorCharge is meaningless downstream.
  • Tools that read mzIdentML or pepXML — use the Results group on the Run / Info tab. It writes results.sage.mzid (mzIdentML 1.1.1) and results.sage.pep.xml (pepXML 1.23) next to the Sage output. The mzIdentML file passes strict schema validation. The pepXML file does not, because the pepXML 1.23 schema does not list Sage as a search engine and the file names it as Sage. Both files were parsed with zero errors by pyteomics, an independent Python reader, on a real 9,392-entry run. No specific target tool (Scaffold, Skyline, PeptideShaker, TPP) has opened either file yet.
  • Percolator or mokapot — PSM rescoring. Tick Write PIN file under Search output on the Run / Info tab to write results.sage.pin. Verified: mokapot loads it with the exact target and decoy counts from the search and completes a full semi-supervised rescoring run.
  • Spectral-library builders and manual QC tools that read per-fragment match detail — tick Annotate Matches under Search output to write matched_fragments.sage.tsv (ion type, ordinal, charge, calculated and observed m/z, intensity). Verified against a real run: every fragment row traces to a real PSM, and results.sage.tsv's match-quality columns reproduce correctly from it.

Citation

If you use SageGUI in published work, please cite the software:

Neely, B.A. (2026). SageGUI: a graphical interface for the Sage proteomics search engine (Version 0.9.0) [Computer software]. National Institute of Standards and Technology. https://github.com/neely/sagegui

Cite the version you ran, not the repository in general. The pinned Sage engine version and the bundled templates both move between releases, so two versions of SageGUI do not necessarily run the same search. The Run / Info tab prints the SageGUI version and the Sage engine version it was built against.

A CITATION.cff file is included, so GitHub's "Cite this repository" control produces the same reference in BibTeX or APA.

Please also cite Sage, which performs the searches:

Lazear, M.R. "Sage: An Open-Source Tool for Fast Proteomics Searching and Quantification at Scale." Journal of Proteome Research 2023, 22(11), 3652–3659. doi:10.1021/acs.jproteome.3c00486

Attribution

This project is an officially supported NIST fork of Sebastian Paez’s sagegui, built on Sage:

Full upstream license texts are provided in THIRD_PARTY_LICENSES.md.

Credits

  • Michael Lazear — Sage
  • Sebastian Paez — original sagegui
  • egui/eframe — GUI framework

License

NIST-authored portions of this project are distributed under the NIST Software Licensing Statement — see LICENSE. Third-party components (Sage and the original sagegui) retain their original licenses; see THIRD_PARTY_LICENSES.md for details.

Project FAIR and governance practices are described in fair-software.md.

Contact

Benjamin A. Neely — PI
Data Science and AI Group, Material Data Division, Material Measurement Laboratory, National Institute of Standards and Technology
benjamin.neely@nist.gov

About

No description, website, or topics provided.

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages