mingjiewang/qap repository overview

⁠QAP

QAP⁠ (Quasispecies Analysis Package) is an integrated software to analyze viral quasispecies (QS) high through-put sequencing data, including next generation sequencing (NGS) and third generation sequencing (TGS) data.

Virus community, also known as Quasispecies (QS) is highly related to pathogenesis of viral infectious diseases. Recent development of high through-put sequencing have dramatically lowered the cost and labor of QS detection, yet making computational analysis a major limiting step and an enormous challenge. There is an urgent need for an integrated workflow combining different processing steps in quasispecies studies to discover clinical significance underlying virus populations that could be used on a daily basis by clinicians and virologists. That's why we developed QAP, a powerful all-in-one software to solve the problem.

There are 41 tools included in QAP till now, and all these tools are classified into 6 categories.

• Raw data preprocessing
• Sequences manipulations
• Quasispecies characterization
• Multiple samples comparison
• Useful tools
• Visualization and plots

After you download and use QAP with commands below.

# Get docker image
$ docker pull mingjiewang/qap

# Run QAP image in a container
$ docker run -it -v /tmp/db:/tmp/db -v /tmp/input:/tmp/input mingjiewang/qap /usr/bin/bash

# Now, enjoy! 
$ qap

QAP does not only provide command line tools, but also provide a pretty GUI and web applications for users who are uncomfortable with command lines. For more information, please visit QAP website⁠.

⁠Requirements

Referring to hardware requirements for running QAP, there aren't any indispensable ones. If there must be some to be listed, maybe a machine with memory >= 2G, physical threads >= 4 and as much as free disk space, which will give users a stable and faster computing performance. Referring to operating systems, as most of QAP is written Perl, R and Java, which are all cross-platform programming languages. So, theoretically, if you get Perl, R and Java ready on your system, QAP can run on Linux, Windows and Mac OS. However, some of the third-party softwares used by QAP can only run on Linux/Unix based systems, thus making Linux/Unix the recommended system.

We have tested QAP on CentOS, Ubuntu/Debian, RedHat and MacOS, and they all run successfully. Windows OS is not tested yet, but some tools which doesn't depends on Linux based third party tools might run successfully. If you are stucked with Windows OS, please try Cygwin⁠ or virtual machine softwares, e.g. VMware⁠, which is extraordinary.

For more information about installation and requirement details, please go to QAP website⁠.

⁠Basic Usage

All tools could be invoked from the wrapped main program. Thus, the usage of QAP is quite easy. Just follow the command below.

# General command
$ qap \[Tool name\] \[Arguments\]

# Help information
$ qap -h or qap \[Tool name\] -h

# Initiate GUI
$ qap -g

⁠Github

We also stored the source code at Github. Download QAP⁠ or clone it using

$ git clone https://github.com/mingjiewang/qap.git

⁠How to contribute?

Please fork the GitHub QAP repository⁠, modify it, and submit a pull request to us.

⁠Maintainer

Author: Mingjie Wang⁠

Email: [email protected]⁠

Affiliation: Bioinformatics center⁠, Ruijin Hospital, Shanghai Jiaotong University, School of Medicine

⁠License

Main program GPL3⁠

R package MIT⁠

Related Other Resources: Creative Commons Attribution-NonCommercial-NoDerivatives 4.0 International License⁠