Skip to content
Snippets Groups Projects
README.rst 3.1 KiB
Newer Older
RapidPeptidesGenerator (RPG)
============================
Nicolas  MAILLET's avatar
Nicolas MAILLET committed

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
Rapid Peptides Generator (RPG) is a software dedicated to predict proteases-induced cleavage sites on amino acid sequences.

.. image:: https://badge.fury.io/py/rpg.svg
    :target: https://badge.fury.io/py/rpg
    :alt: Pypi repo

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
.. image:: https://gitlab.pasteur.fr/nmaillet/rpg/-/badges/release.svg
    :target: https://gitlab.pasteur.fr/nmaillet/rpg/-/releases
    :alt: Latest release

.. image:: https://gitlab.pasteur.fr/nmaillet/rpg/badges/master/pipeline.svg
    :target: https://gitlab.pasteur.fr/nmaillet/rpg/commits/master
    :alt: Build Status

.. image:: https://gitlab.pasteur.fr/nmaillet/rpg/badges/master/coverage.svg
    :target: https://gitlab.pasteur.fr/nmaillet/rpg/commits/master
    :alt: Coverage Report

.. image:: https://readthedocs.org/projects/rapid-peptide-generator/badge/?version=latest
Nicolas  MAILLET's avatar
Nicolas MAILLET committed
    :target: https://rapid-peptide-generator.readthedocs.io/en/latest/?badge=latest
    :alt: Documentation Status

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
.. image:: https://archive.softwareheritage.org/badge/origin/https://gitlab.pasteur.fr/nmaillet/rpg/
    :target: https://archive.softwareheritage.org/browse/origin/?origin_url=https://gitlab.pasteur.fr/nmaillet/rpg
    :alt: Software Heritage Status

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
:note: RPG is tested with Gitlab Ci for the following Python version: 3.6 to 3.12
:issues: Please use https://gitlab.pasteur.fr/nmaillet/rpg
:publication: To cite RPG, please refer to https://doi.org/10.1093/nargab/lqz004
Rapid Peptides Generator (RPG), is a standalone software dedicated to predict proteases-induced cleavage sites on sequences.
RPG is a python tool taking a (multi-)fasta/fastq file (gzipped or not) of proteins as input and digest each of them. The digestion mode can be either 'concurrent', i.e. all enzymes are present at the same time during digestion, or 'sequential'. In sequential mode, each protein will be digested by each enzyme, one by one.
The resulting peptides contain information about positions of cleavage site, peptide sequences, length, mass as-well as an estimation of isoelectric point (pI) of each peptide. Shortly, the isoelectric point is the pH at which a peptide carries no net electrical charge and a good approximation can be computed on small molecules. Results are outputted in multi-fasta, CSV or TSV file.
Nicolas  MAILLET's avatar
Nicolas MAILLET committed
Currently, 45 enzymes and chemicals are included in RPG. The user can easily design new enzymes, using a simple yet powerful grammar. This grammar allows the user to design complex enzymes like trypsin or thrombin, including many exceptions and different cleavage sites. User-defined enzymes are then interpreted by RPG and included in the local installation of the software.
Nicolas  MAILLET's avatar
Nicolas MAILLET committed
RPG follows the standards for software development with continuous integration on Gitlab (https://gitlab.pasteur.fr/nmaillet/rpg) and automatic on-line documentation (https://rapid-peptide-generator.readthedocs.io).
Installation
============

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
In order to install RPG, you can use **pip**:

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
.. code-block:: shell
Nicolas  MAILLET's avatar
Nicolas MAILLET committed
    pip3 install rpg

This command installs RPG and its Python dependencies.


Usage
=====

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
From the command line:

Nicolas  MAILLET's avatar
Nicolas MAILLET committed
.. code-block:: shell