Skip to content

Repository files navigation

snakemake-ms-proteomics

Snakemake Snakemake Tests GitHub issues GitHub last commit run with conda workflow catalog


A Snakemake workflow for automatic processing and quality control of protein mass spectrometry data.

Usage

The usage of this workflow is described in the Snakemake Workflow Catalog.

Detailed information about input data and workflow configuration can also be found in the config/README.md.

If you use this workflow in a paper, don't forget to give credits to the authors by citing the URL of this repository or its DOI.

workflow overview


This workflow is a best-practice workflow for the automated analysis of mass spectrometry proteomics data. It currently supports automated analysis of data-dependent acquisition (DDA) data with label-free quantification. An extension by different workflows (DIA, isotope labeling) is planned in the future.

The workflow is mainly a wrapper for the excellent tools fragpipe and MSstats, with additional modules that supply and check the required input files, and generate reports. The workflow is built using snakemake and processes MS data using the following steps:

  1. Prepare workflow file (python script)
  2. Check user-supplied sample sheet (python script)
  3. Check user-supplied database FASTA file (python script)
  4. Generate decoy proteins (DecoyPyrat)
  5. Import raw files, search protein database (fragpipe)
  6. Align feature maps using IonQuant (fragpipe)
  7. Import quantified features, infer and quantify proteins (R MSstats)
  8. Compare different biological conditions, export results (R MSstats)
  9. Generate HTML report with embedded QC plots (R markdown)
  10. Generate PDF report from HTML weasyprint
  11. Send out report by email (python script)
  12. Clean up temporary files after workflow execution (bash script)

If you want to contribute, report issues, or suggest features, please get in touch on github.

Deployment options

To run the workflow from command line, change the working directory.

cd path/to/snakemake-workflow-name

Adjust options in the default config file config/config.yml. Before running the complete workflow, you can perform a dry run using:

snakemake --dry-run

To run the workflow with test files using conda:

snakemake --cores 4 --sdm conda --directory .test

Authors

License

  • the contents of this repository are licensed with the MIT License
    • you are free use the workflow for your purposes free of charge
    • you are free to modify the contents and create derivative work
    • the only condition is that you refer to the original license and copyright owners (MPUSP)
    • all contents come with absolutely no warranty to work for your or any other purposes
    • all third party dependencies are licensed under their own terms and not covered by this license

References

  • Essential tools are linked in the top section of this document
  • The core of this workflow are the two external packages fragpipe and MSstats

fragpipe

  1. Kong, A. T., Leprevost, F. V., Avtonomov, D. M., Mellacheruvu, D., & Nesvizhskii, A. I. (2017). MSFragger: ultrafast and comprehensive peptide identification in mass spectrometry–based proteomics. Nature Methods, 14(5), 513-520.
  2. da Veiga Leprevost, F., Haynes, S. E., Avtonomov, D. M., Chang, H. Y., Shanmugam, A. K., Mellacheruvu, D., Kong, A. T., & Nesvizhskii, A. I. (2020). Philosopher: a versatile toolkit for shotgun proteomics data analysis. Nature Methods, 17(9), 869-870.
  3. Yu, F., Haynes, S. E., & Nesvizhskii, A. I. (2021). IonQuant enables accurate and sensitive label-free quantification with FDR-controlled match-between-runs. Molecular & Cellular Proteomics, 20.

MSstats

  1. Choi M (2014). MSstats: an R package for statistical analysis of quantitative mass spectrometry-based proteomic experiments. Bioinformatics, 30.

About

Pipeline for automatic processing and quality control of mass spectrometry data

Topics

Resources

Stars

14 stars

Watchers

1 watching

Forks

Releases

Packages

Used by

Contributors

Languages