annotator

A simple tool to help you manually discover the depths of your (complex) spectra, one spectrum at a time.

https://github.com/snijderlab/annotator

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • CITATION.cff file
    Found CITATION.cff file
  • codemeta.json file
    Found codemeta.json file
  • .zenodo.json file
    Found .zenodo.json file
  • DOI references
  • Academic publication links
  • Committers with academic emails
  • Institutional organization owner
  • JOSS paper metadata
  • Scientific vocabulary similarity
    Low similarity (9.3%) to scientific vocabulary

Keywords

cross-linking glycans mass-spectrometry proteomics
Last synced: 6 months ago · JSON representation ·

Repository

A simple tool to help you manually discover the depths of your (complex) spectra, one spectrum at a time.

Basic Info
  • Host: GitHub
  • Owner: snijderlab
  • License: mit
  • Language: Rust
  • Default Branch: main
  • Homepage:
  • Size: 6.36 MB
Statistics
  • Stars: 28
  • Watchers: 1
  • Forks: 2
  • Open Issues: 18
  • Releases: 17
Topics
cross-linking glycans mass-spectrometry proteomics
Created over 2 years ago · Last pushed 6 months ago
Metadata Files
Readme Changelog License Citation

README.md

Annotator

A simple tool to help you manually discover the depths of your (complex) spectra, one spectrum at a time. Load your rawfiles, select a spectrum and add your annotation with full control over theoretical fragments. Use the interactive spectrum to discover what your spectrum means and to export gorgeous images.

Bottom-up peptide

It can even make nice pictures from glycans as seen below.

Glycan peptide

Features

[!TIP] Do you have some very complex feature in your spectra? It is extremely likely the Annotator can annotate it.

  • Open raw files (mgf, mzML, Thermo RAW, Bruker .tdf)
  • Full ProForma 2.0 support:
    • Complex modifications, from Unimod, PSI-MOD, Resid, and XLMOD, but also masses and formula
    • Ambiguous modifications
    • Cross-linked peptidoforms
    • Chimeric spectra, which includes DIA
    • Glycans, both structures and compositions
  • Supports complex and highly customizable fragmentation models
    • Has built in models for: HCD, CID, ETD, top-down ETD, EtHCD, EtCAD, EAD, EAciD, UVPD
  • Supports custom modifications
  • Supports loading and searching in 20+ identified peptides file formats
    • Amongst others: msFragger, PEAKS, mzTAB, SSL
  • Extensive control over the visualisation
  • Export to PDF (do not forget to turn on background graphics in the advanced settings while printing)

[!TIP] There is also a more comprehensive guide

Peptidoform sequence

It uses the ProForma 2.0 specification to specify the sequence. Here are some examples of valid sequences:

  • VAEINPSNGGTTFNEKFKGGKATJ Normal aminoacids
  • EM[L-methionine sulfoxide]EVEES[UNIMOD:21]PEK Modifications using Unimod and PSI-MOD
  • TFNEKF[+15.9949]KGGKATJ Modifications using raw masses
  • TFNEKF[Formula:O]KGGKATJ Modifications using elemental formula
  • TFNEKF[Glycan:HexNAc1Hex2]KGGKATJ Modifications glycan compositions
  • [+16]-TFNEKFKGGKATJ-[Methyl] Terminal modifications
  • <15N>TFNEKFKGGKATJ Global isotope modifications (all Nitrogen is 15N)
  • <[S-carboxamidomethyl-L-cysteine]@C>AVYYCSRWGGDGFYAMDYWGQG Global modifications (all C are carboxamidomethylated)
  • [UNIMOD:374]?TFNEKFCKGGCKATJ Modifications where the location is unknown
  • TFNEKFC[UNIMOD:374#g1]KGGC[#g1]KATJ (identical to the one above)
  • TFNEKF(CKGGCK)[UNIMOD:374#g1]ATJ (identical to the one above)
  • VAEINPSNGGTT+FNEKFKGGKATJ Multimeric spectra, meaning two separate peptides are in your spectrum at the same time
  • VAEINK[X:DSSO#XL1]SNGGTT//WAK[#XL1]INK A DSSO cross-link between two lysines on two peptides (note the use of // versus + to indicate cross-linked peptides)
  • VAEINK[X:DSSO#XL1]SNGGTT A hydrolysed DSSO cross-linker

Installing

Using winget

On windows use:

[!NOTE]
winget install --id Snijderlab.Annotator.

From binary

See releases for the latest release, here you will also find the prebuilt binaries for your architecture.

From source

To build from source. Clone the repository. And build with cargo tauri dev. Make sure you have installed Rust and Tauri beforehand.

Thermo RAW files

The .NET 8.0 runtime is needed to open Thermo RAW files. Which can be downloaded here. Additionally on windows you can use winget install Microsoft.DotNet.Runtime.8 for a quick install.

Note on custom modifications and models

Custom modifications can be defined, these allow diagnostic ions and neutral losses to be defined. Additionally custom cross-linkers can be defined to have certain cleavage patterns that can then be searched for in the annotator. The custom modifications are stored in a separate json file on your computer. Updating the Annotator will not remove any previously defined modifications. Additionally copying this file to another computer will copy the whole database to that computer. This can be used to move all your definitions to a new computer when upgrading or to aid a colleague with your definitions.

For custom models much of the same is true. These allow highly advanced fragmentation rules to be set. These models will also not be removed when updating and can be shared and backed up in the same way.

Owner

  • Name: snijderlab
  • Login: snijderlab
  • Kind: organization
  • Location: Netherlands

Research lab under @joostsnijder at the @UtrechtUniversity.

Citation (CITATION.cff)

title: Annotator
version: 1.0.0
abstract:  A rust library for parsing Pro Forma peptides and matching them against MS spectra .
authors:
  - affiliation: Utrecht University
    family-names: Schulte
    given-names: Douwe
    orcid: https://orcid.org/0000-0003-0594-0993
  - affiliation: Utrecht University
    family-names: Heerdink
    given-names: Auke
cff-version: 1.2.0
identifiers:
  - description: Release paper (preprint)
    type: doi
    value: 10.1101/2025.01.18.633732 
  - description: Repository
    type: url
    value: https://github.com/snijderlab/annotator
keywords:
  - mass-spectrometry
  - de novo
license: MIT OR Apache-2.0
message: If you use this software, please cite it using these metadata.
repository-code: https://github.com/snijderlab/annotator

GitHub Events

Total
  • Create event: 7
  • Release event: 5
  • Issues event: 10
  • Watch event: 18
  • Delete event: 3
  • Issue comment event: 12
  • Push event: 109
  • Pull request event: 3
  • Fork event: 2
Last Year
  • Create event: 7
  • Release event: 5
  • Issues event: 10
  • Watch event: 18
  • Delete event: 3
  • Issue comment event: 12
  • Push event: 109
  • Pull request event: 3
  • Fork event: 2

Committers

Last synced: 8 months ago

All Time
  • Total Commits: 355
  • Total Committers: 2
  • Avg Commits per committer: 177.5
  • Development Distribution Score (DDS): 0.003
Past Year
  • Commits: 169
  • Committers: 2
  • Avg Commits per committer: 84.5
  • Development Distribution Score (DDS): 0.006
Top Committers
Name Email Commits
Douwe Schulte d****e@u****l 354
Auke Heerdink 2****k 1
Committer Domains (Top 20 + Academic)
uu.nl: 1

Issues and Pull Requests

Last synced: 6 months ago

All Time
  • Total issues: 43
  • Total pull requests: 3
  • Average time to close issues: 3 months
  • Average time to close pull requests: 43 minutes
  • Total issue authors: 6
  • Total pull request authors: 2
  • Average comments per issue: 0.51
  • Average comments per pull request: 0.67
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Past Year
  • Issues: 6
  • Pull requests: 3
  • Average time to close issues: 16 days
  • Average time to close pull requests: 43 minutes
  • Issue authors: 5
  • Pull request authors: 2
  • Average comments per issue: 1.33
  • Average comments per pull request: 0.67
  • Merged pull requests: 1
  • Bot issues: 0
  • Bot pull requests: 0
Top Authors
Issue Authors
  • douweschulte (32)
  • RienLeuvenink (6)
  • ShelleyJager (2)
  • juank1892 (1)
  • apoetsch (1)
  • zouboulk (1)
  • aukeheerdink (1)
Pull Request Authors
  • douweschulte (2)
  • aukeheerdink (1)
Top Labels
Issue Labels
bug (3) enhancement (2) P-long-term (2)
Pull Request Labels

Dependencies

.github/workflows/release.yml actions
  • actions/checkout v3 composite
  • actions/setup-node v3 composite
  • dtolnay/rust-toolchain stable composite
  • tauri-apps/tauri-action v0 composite
src-tauri/Cargo.lock cargo
  • 373 dependencies
src-tauri/Cargo.toml cargo