From cf7d469b1d242c541c1faaaa36049069b57f867b Mon Sep 17 00:00:00 2001 From: Nico Maillet <nicolas.maillet@pasteur.fr> Date: Wed, 3 Feb 2021 16:16:03 +0100 Subject: [PATCH] Update doc for gzipped and parallel --- README.rst | 2 +- docs/userguide.rst | 4 +++- 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/README.rst b/README.rst index fe30995..e523cdd 100644 --- a/README.rst +++ b/README.rst @@ -29,7 +29,7 @@ Overview 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 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. +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 informations 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. diff --git a/docs/userguide.rst b/docs/userguide.rst index cf5f9eb..6462801 100644 --- a/docs/userguide.rst +++ b/docs/userguide.rst @@ -162,7 +162,7 @@ Here are all available options in **RPG**: **-f, -\\-fmt**: Output file format. Either 'fasta', 'csv', or 'tsv' (default: fasta). See :ref:`formats` for more information. -**-i, -\\-inputdata**: Input file, in (multi)fasta / fastq format. See :ref:`onefile` for example. +**-i, -\\-inputdata**: Input file, in (multi)fasta / fastq format (gzipped or not). See :ref:`onefile` for example. **-s, -\\-sequence**: Input a single protein sequence without commentary. See :ref:`oneseq` for example. @@ -178,6 +178,8 @@ Here are all available options in **RPG**: **-r, -\\-randomname**: Random (not used) output name file. See :ref:`random` for more information. +**-c , -\\-processes**: Number of parallel processes to use (default: 1) + **-q, -\\-quiet**: No standard output, only error(s). **-v, -\\-verbose**: Increase output verbosity. -vv will increased more than -v. See :ref:`verbose` for more information. -- GitLab