Common utilities for parsing and handling peptide-spectrum matches and search engine results.

Navigation

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Arthur_declercq from gravatar.com Arthur_declercq Avatar for RalfG from gravatar.com RalfG

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR U...)
  • Author: Ralf Gabriels
  • Tags proteomics, peptide, spectrum, identification, parsing
  • Requires: Python >=3.7
  • Provides-Extra: dev, docs, online
Classifiers

Project description

Common utilities for parsing and handling peptide-spectrum matches and search engine results in Python.

GitHub release PyPI Bioconda GitHub Actions tests status GitHub Actions build status Codecov GitHub Twitter

About

Introduction

psm_utils is a Python package with utilities for parsing and handling peptide-spectrum matches (PSMs) and proteomics search engine results. It is mainly developed to be used in Python packages developed at CompOmics, such as MS²PIP, DeepLC, and MS²Rescore, but can be useful to anyone dealing with PSMs and PSM files. Moreover, it provides an easy-to-use CLI and web server to convert search engine results from one PSM file format into another.

Goals and non-goals

  • To provide an easy-to-use Python API for handling PSMs.

  • To provide a unified Python API to the plethora of proteomics search engine output formats that are in existence.

  • To follow community standards: psm_utils pragmatically adheres to the standards developed by the HUPO Proteomics Standards Initiative, such as ProForma 2.0 , the Universal Spectrum Identifier, and mzIdentML

  • To be open and dynamic: psm_utils is fully open source, under the permissive Apache 2.0 license. New reader and writer modules can easily be added, and we welcome everyone to contribute to the project. See Contributing for more information.

  • NOT to reinvent the wheel: Instead, psm_utils heavily makes use of packages such as pyteomics and psims that have existing functionality for reading and/or writing PSM files. psm_utils.io provides a unified, higher level Python API build on top of these packages.

Supported file formats

File format

psm_utils tag

Read support

Write support

FlashLFQ generic TSV

flashlfq

✅

✅

ionbot CSV

ionbot

✅

❌

OpenMS idXML

idxml

✅

✅

MaxQuant msms.txt

msms

✅

❌

MS Amanda CSV

msamanda

✅

❌

mzIdentML

mzid

✅

✅

Parquet

parquet

✅

✅

Peptide Record

peprec

✅

✅

pepXML

pepxml

✅

❌

Percolator tab

percolator

✅

✅

Proteome Discoverer MSF

proteome_discoverer

✅

❌

Sage Parquet

sage_parquet

✅

❌

Sage TSV

sage_tsv

✅

❌

ProteoScape Parquet

proteoscape

✅

❌

TSV

tsv

✅

✅

X!Tandem XML

xtandem

✅

❌

Legend: ✅ Supported, ❌ Unsupported

psm_utils online

Open in streamlit

psm_utils online is a Streamlit-based web server built on top of the psm_utils Python package. It allows you to easily retrieve proteomics PSM statistics for any supported PSM file type, and to convert search engine results from one PSM file format into another. Click the badge above to get started!

Installation

Install with pip 
pip install psm-utils
Install with Bioconda 
conda install -c bioconda psm-utils

Full documentation

The full documentation, including a quickstart guide and Python API reference is available on psm_utils.readthedocs.io.

Citation

If you use psm_utils for your research, please cite the following publication:

psm_utils: A high-level Python API for parsing and handling peptide-spectrum-matches and proteomics search results.
Ralf Gabriels, Arthur Declercq, Robbin Bouwmeester, Sven Degroeve, Lennart Martens.
Journal of Proteome Research (2022). doi:10.1021/acs.jproteome.2c00609

Project details

Verified details

These details have been verified by PyPI
Project links
GitHub Statistics
Maintainers
Avatar for Arthur_declercq from gravatar.com Arthur_declercq Avatar for RalfG from gravatar.com RalfG

Unverified details

These details have not been verified by PyPI
Project links
Meta
  • License: Apache Software License (Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR U...)
  • Author: Ralf Gabriels
  • Tags proteomics, peptide, spectrum, identification, parsing
  • Requires: Python >=3.7
  • Provides-Extra: dev, docs, online
Classifiers

Release history Release notifications | RSS feed

This version

1.1.1

1.1.0

1.0.1

1.0.0

0.9.0

0.8.3

0.8.2

0.8.1

0.8.0

0.7.4

0.7.3

0.7.2

0.7.1

0.7.0

0.6.1

0.6.0

0.5.0

0.4.1

0.4.0

0.3.1

0.3.0

0.2.3

0.2.2

0.2.1

0.2.0

0.1.0

0.1.0.dev1 pre-release

0.1.0.dev0 pre-release

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

psm_utils-1.1.1.tar.gz (69.9 kB view details)

Uploaded Source

Built Distribution

psm_utils-1.1.1-py3-none-any.whl (79.0 kB view details)

Uploaded Python 3

File details

Details for the file psm_utils-1.1.1.tar.gz.

File metadata

  • Download URL: psm_utils-1.1.1.tar.gz
  • Upload date:
  • Size: 69.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for psm_utils-1.1.1.tar.gz
Algorithm Hash digest
SHA256 8926d8f5e2e05ac38d54d6ae5c89461568085b60d23414a907c820bc674a4a2b
MD5 700a9fa17924de1726f435200245c2b7
BLAKE2b-256 8c39230f89d8428e30043b3745944abdc47aece8df17216f3e287ed266d74ccd

See more details on using hashes here.

File details

Details for the file psm_utils-1.1.1-py3-none-any.whl.

File metadata

  • Download URL: psm_utils-1.1.1-py3-none-any.whl
  • Upload date:
  • Size: 79.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.1.1 CPython/3.12.6

File hashes

Hashes for psm_utils-1.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 0b164f1fd25cf8d64258f09d3d899f5ba0445d09b05ce382373bb7571a4e1d37
MD5 89d6b87179cd04705fc2c6521a3663a5
BLAKE2b-256 8f7f5734a81faaf4bc8d2bd58f9d6a985573559c2466f2fce2d875dc0a3a57ba

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page