Skip to content

MS Annika is a crosslink search engine based on MS Amanda, aimed at identifying crosslinks of cleavable and non-cleavable crosslinkers from MS2 and MS3 spectra.

License

Notifications You must be signed in to change notification settings

hgb-bin-proteomics/MSAnnika

Repository files navigation

MS Annika

MS Annika is a crosslink search engine based on MS Amanda, aimed at identifying crosslinks of cleavable and non-cleavable crosslinkers from MS2 and MS3 spectra.

You can read more about MS Annika here:

Description URL
MS Annika 3.0 Publication: doi.org/10.1038/s42004-024-01386-x
MS Annika 2.0 Publication: doi.org/10.1021/acs.jproteome.3c00325
MS Annika 1.0 Publication: doi.org/10.1021/acs.jproteome.0c01000
IMP PD Nodes Website: ms.imp.ac.at/?action=ms-annika

This repository contains the latest release versions of MS Annika:

Version Download URL
Latest MS Annika 3.0 version for Proteome Discoverer 3.1 download
Latest MS Annika 2.0 version for Proteome Discoverer 3.0 download
Latest MS Annika 2.0 version for Proteome Discoverer 2.5 download
Latest MS Annika 1.0 version for Proteome Discoverer 2.4 download
Latest MS Annika 1.0 version for Proteome Discoverer 2.3 download

A list of changes in every version can be found in HISTORY.md.

Please note that only MS Annika 3.0 (and above) supports identification of non-cleavable crosslinks and only MS Annika 2.0 (and above) supports identification from MS2-MS2-based acquisition workflows!

Installation

MS Annika is a plug-in for the proteomics software Proteome Discover by Thermo Fisher Scientific. Installation of MS Annika requires:

  • Installation of Proteome Discoverer (can be downloaded for free from here)
    • (Requirements of Proteome Discoverer apply)
  • Installation of MS Annika via the installer available from this repository
    • There are no additional requirements other than Proteome Discoverer
    • Users will be asked to accept the MS Annika license agreement (MS Annika is licensed as freeware)
    • The typical installation of MS Annika does not take longer than 5 minutes

The tutorial also covers the installation in detail.

Usage

MS Annika makes use of the workflow interface in Proteome Discoverer, which should be straight-forward to use. Step by step instructions for people unfamiliar with Proteome Discoverer are given in the tutorial. The below sections also give an overview of parameters, results, example workflows and example data. Typically an analysis with MS Annika takes a few minutes for small samples and up to a few hours for larger samples and proteome-wide searches. Please also refer to the specific sections for Astral and timsTOF data if you are analyzing such data.

Parameters & Results

Please refer to the MS Annika User Manual for a detailed description of all MS Annika parameters as well as descriptions of all result tables. For further down-stream analysis of MS Annika results we recommend taking a look at MS Annika Extensions.

Tutorial

A tutorial of how to use MS Annika 3.0 can be found here: Text / Video

Example Files

Example files to try MS Annika 3.0 can either be downloaded from PRIDE or directly here:

  • Minimal example for a cleavable crosslink MS2 search: MGF + fasta
  • RAW file for a non-cleavable crosslink MS2 search: RAW
  • RAW file for a cleavable crosslink MS3 search: RAW

Example Workflows

Example workflows that can be used in Proteome Discoverer:

  • Proteome Discoverer 3.0 / 3.1:
    • DSS/BS3 MS2 search (CID, ETD, HCD, stepped HCD): pdAnalysis / zip
    • DSS/BS3 MS2 search (for large datasets and proteome-wide searches, CID, ETD, HCD, stepped HCD): pdAnalysis / zip
    • DSSO MS2 search (CID, ETD, HCD, stepped HCD): pdAnalysis / zip
    • DSSO MS2-MS3 search (MS3 recorded in the orbitrap): pdAnalysis / zip
    • DSSO MS2-MS3 search (MS3 recorded in the ion trap): pdAnalysis / zip
    • DSBSO MS2 search (CID, ETD, HCD, stepped HCD): pdAnalysis / zip
    • DSBSO MS2-MS3 search (MS3 recorded in the orbitrap): pdAnalysis / zip
    • DSBSO MS2-MS3 search (MS3 recorded in the ion trap): pdAnalysis / zip
  • Proteome Discoverer 2.5:
    • DSSO MS2 search (CID, ETD, HCD, stepped HCD): pdAnalysis / zip
    • DSSO MS2-MS3 search (MS3 recorded in the orbitrap): pdAnalysis / zip
    • DSSO MS2-MS3 search (MS3 recorded in the ion trap): pdAnalysis / zip

The provided workflows also require the installation of MS Amanda which can be downloaded here.

The general processing workflow for almost any crosslink search is depicted here.

For MS2 searches (CID, ETD, HCD, stepped HCD) it can also be beneficial to employ the IMP MS2 Spectrum Processor node, an example workflow for Proteome Discoverer 3.0 is given here:

  • DSSO MS2 search with IMP MS2 Spectrum Processor: pdAnalysis / zip

This workflow additionally requires the installation of the IMP MS2 Spectrum Processor node beforehand, which can be directly downloaded from here (Proteome Discoverer 3.0).

Support for Astral Data

In order to process crosslinking data from Astral instruments we recommend using MS Annika 3.0 v3.0.5 or greater (e.g. latest). Although theoretically all MS Annika versions support Astral data, earlier versions require sufficient hardware for processing RAW files of more than 100 000 spectra (specifically enough memory, 128GB+ is recommended). MS Annika version 3.0.5+ is memory optimized and runs on standard commodity hardware. We also recommend disabling the following parameter:

  • MS Annika Detector Node:
    • Doublet Selection:
      • Try infer missing charge states: False (If this parameter is not visible, please check that Show Advanced Parameters is on).

Support for MGF and timsTOF Data

The following MS Annika versions support MGF* and timsTOF** data input:

*MS Annika 3.0 only supports MS2 search for MGF files since MGF files don't contain sufficient MS3 information.
**optionally requires installation of the Bruker Ion Mobility reader to display ion mobilities in Proteome Discoverer, the node is not needed for crosslink search.
***requires installation of the IMP MS2 Spectrum Processor node.

Getting Help

In case something isn't working or if you need any help with MS Annika or one of the MS Annika extensions, please don't hesitate to reach out to us. You can open up an issue here or start a discussion there. We are usually fast to respond on GitHub and other users might be able to help too! Alternatively, you can always drop us an email at the addresses below.

Known Issues

List of known issues

Contributing & Source Code

The MS Annika codebase contains proprietary code and therefore can't be made open source. If you want to contribute to the development of MS Annika please contact us and we are happy to team up!

Citing

If you are using MS Annika please cite one of the following publications:

Contact

About

MS Annika is a crosslink search engine based on MS Amanda, aimed at identifying crosslinks of cleavable and non-cleavable crosslinkers from MS2 and MS3 spectra.

Topics

Resources

License

Stars

Watchers

Forks

Packages

No packages published