sib-swiss / pftools3

A suite of tools to build and search generalized profiles
GNU General Public License v2.0
10 stars 7 forks source link
motif profile protein-domains sequence-analysis

install with bioconda install with EasyBuild install with Docker install with Singularity Anaconda-Server Badge Anaconda-Server Badge

PfTools

Table of Contents

Foreword

(C) Copyright SIB Swiss Institute of Bioinformatics available from https://github.com/sib-swiss/pftools3 under GPL v2. See LICENSE.

Version 3 contains the original FORTRAN 77 pftools (release 2.3) and the new pftoolsV3 programs.

Installation

Using Docker

First you must have Docker installed and running.
Secondly have a look at the availabe pftools biocontainers at quay.io or at Docker Hub.
Then:

# get the chosen pftools container version
docker pull quay.io/biocontainers/pftools:3.2.11--pl5321r41h4b1256a_2
#   or
docker pull sibswiss/pftools:3.2.12
# use an pftools's tool e.g. pfscan 
docker run quay.io/biocontainers/pftools:3.2.11--pl5321r41h4b1256a_2 pfscan -h
#   or
docker run sibswiss/pftools:3.2.12 pfscan -h

Using Singularity

First you must have Singularity installed and running. Secondly have a look at the availabe pftools biocontainers at quay.io or at Docker Hub.
Then:

# get the chosen pftools container version
singularity pull docker://quay.io/biocontainers/quay.io/biocontainers/pftools:3.2.11--pl5321r41h4b1256a_2
#   or
singularity pull docker://sibswiss/pftools:3.2.12
# run the container
singularity run pftools_3.2.11--pl5321r41h4b1256a_2.sif

You are now in the container. You can use an pftools's tool e.g. pfscan doing

pfscan -h

Bioconda

conda install -c bioconda pftools

EasyBuild

eb --robot --rpath pftoolsV3-3.2.11-foss-2021a.eb

Manually

See here for more information

After installation, in the share/examples/ subdirectory, the test_V3.sh shell script is a good starting point for using pfsearchV3/pfscanV3.

Generalized profile syntax

A description of the generalized profile syntax is given in file:

it was originally published in

Algorithms description

Technical details about how profiles can be constructed and parametrized are summarized in file:

The very first paper describing the PFTOOLS algorithms is

The generalized profile alignment method is closely related to other "classical" algorithm for aligning sequences. For example, it encompasses the Smith-Waterman algorithm and the Viterbi decoding of profile-HMM (as implemented in HMMER2 for example). Relationships between these algorithm were investigated in

Relatively detailed explanations about the profile normalized scores, as well as its comparisons with other popular statistics for sequence alignments can be found in

The heuristic score is succinctly described in

Applications of the Pftools

Two databases were created based on the PFTOOLS technology: PROSITE and HAMAP and they are still actively maintained

  1. https://prosite.expasy.org/
  2. https://hamap.expasy.org/

The PFTOOLS were initially designed with handling capabilities of DNA sequences. The latest released pfsearchV3 feature support for FASTQ and SAM formats. DNA applications are for example given in

Authors

Mas:

Other contributors:

SIB Swiss Institute of Bioinformatics Vital-IT Group Quartier Sorge - Batiment Amphipole 1015 Lausanne Switzerland