https://github.com/cbg-ethz/quasirecomb
Probabilistic inference of viral quasispecies subject to recombination (viral haplotype reconstruction).
Science Score: 23.0%
This score indicates how likely this project is to be science-related based on various indicators:
-
○CITATION.cff file
-
○codemeta.json file
-
○.zenodo.json file
-
✓DOI references
Found 1 DOI reference(s) in README -
○Academic publication links
-
✓Committers with academic emails
1 of 3 committers (33.3%) from academic institutions -
○Institutional organization owner
-
○JOSS paper metadata
-
○Scientific vocabulary similarity
Low similarity (13.2%) to scientific vocabulary
Keywords from Contributors
Repository
Probabilistic inference of viral quasispecies subject to recombination (viral haplotype reconstruction).
Basic Info
Statistics
- Stars: 19
- Watchers: 10
- Forks: 6
- Open Issues: 1
- Releases: 0
Metadata Files
README.md
QuasiRecomb
Dr. Armin Töpfer, armintoepfer.com
RNA viruses are present in a single host as a population of different but related strains. This population, shaped by the combination of genetic change and selection, is called quasispecies. Genetic change is due to both point mutations and recombination events. We present a jumping hidden Markov model that describes the generation of the viral quasispecies and a method to infer its parameters by analysing next generation sequencing data. We offer an implementation of the EM algorithm to find maximum a posteriori estimates of the model parameters and a method to estimate the distribution of viral strains in the quasispecies. The model is validated on simulated data, showing the advantage of explicitly taking the recombination process into account, and validated on experimental HIV samples.
CONTENT:
This java command line application is a toolbox, combining all necessary steps to infer a viral quasispecies from Next Generation Sequencing (NGS) data.
CITATION:
If you use QuasiRecomb, please cite the paper Töpfer et al. in Journal of Computational Biology
DOWNLOAD:
Please get the latest binary at https://github.com/cbg-ethz/QuasiRecomb/releases
FEATURES:
- First algorithm that models the recombination process
- Allows position-wise mutation events
- Infers a parametric probability distribution from the underlying viral population
- Error correction by estimating position-wise sequencing error-rates
- Local, gene- and genome-wide reconstruction
- Reports SNV (single nucleotide variant) posteriors
- Incorporates paired-end information
- Uses PHRED scores to weight each base of each read
- Input may contain paired-end and single reads
- Supports reads of all current sequencing technologies (454/Roche, Illumina and PacBio)
- Suitable for amplicon and shotgun sequencing projects
- Reports reconstructed haplotypes and their relative frequencies
- Reports translated proteins in all three reading frames with their relative frequencies
- Input data can be in BAM or SAM format
PREREQUISITES TO RUN:
- JDK 7 (http://jdk7.java.net/)
HOW-TO:
If you are new to QuasiRecomb, please read the Beginners' guide to viral population inference
RUN:
Local / Global reconstruction
java -jar QuasiRecomb.jar -i alignment.bam
Reads need to be properly aligned.
Conservative reconstruction
-conservative
In this case, only major haplotypes will be reconstructed.
Disregard deletions
-noGaps
If deletions are not of interest, not expected, or only due to technical noise, all deletions will be ignored.
Use fixed number of generators or bigger interval
-K 2
-K 1-8
Reconstruct specific region with respect to reference genome numbering
-r 790-2292
Incorporate PHRED quality scores (slower)
-quality
Disable recombination process
-noRecomb
Filter reads with too large consecutive deletions
-maxDel INT
Filter reads with a too high ratio of deletions
-maxPercDel DOUBLE Interval if between 0.0 - 1.0
Do not merge and pair reads
-unpaired
If read names are not unique and reads are single-end, prevent pairing and merging. Should be used with 454/Roche sequencing data, because read names are often not unique.
Output
The reconstructed DNA haplotype distribution quasispecies.fasta will be saved in the working directory.
An amino acid translation of the quasispecies in all three reading frame is saved as support/quasispeciesprotein(0|1|2).fasta, if -protein is used.
Plots
Summary statistics can be produced with R:
R CMD BATCH support/coverage.R
R CMD BATCH support/modelselection.R
Technical details
To minimize the memory consumption and the number of full garbage collector executions, use:
java -XX:NewRatio=9 -jar QuasiRecomb.jar
If your dataset is very large and you run out of memory, increase the heapspace with:
java -XX:NewRatio=9 -Xms2G -Xmx10G -jar QuasiRecomb.jar
On multicore systems:
java -XX:+UseParallelGC -XX:NewRatio=9 -Xms2G -Xmx10G -jar QuasiRecomb.jar
On multi-CPU systems:
java -XX:+UseParallelGC -XX:+UseNUMA -XX:NewRatio=9 -Xms2G -Xmx10G -jar QuasiRecomb.jar
Unix wrapper:
function qr() { java -XX:+UseParallelGC -Xms2g -Xmx10g -XX:+UseNUMA -XX:NewRatio=9 -jar ~/QuasiRecomb.jar $*; }
Help:
Further help can be showed by running without additional parameters:
java -jar QuasiRecomb.jar
PREREQUISITES COMPILE (only for dev):
- Maven 3 (http://maven.apache.org/)
INSTALL (only for dev):
cd QuasiRecomb
mvn -DartifactId=samtools -DgroupId=net.sf -Dversion=1.8.9 -Dpackaging=jar -Dfile=src/main/resources/jars/sam-1.89.jar -DgeneratePom=false install:install-file
mvn clean package
java -jar QuasiRecomb/target/QuasiRecomb.jar
CONTACT:
Armin Töpfer
armin.toepfer (at) gmail.com
http://www.armintoepfer.com
LICENSE:
GNU GPLv3 http://www.gnu.org/licenses/gpl-3.0
Owner
- Name: Computational Biology Group (CBG)
- Login: cbg-ethz
- Kind: organization
- Location: Basel, Switzerland
- Website: https://www.bsse.ethz.ch/cbg
- Twitter: cbg_ethz
- Repositories: 91
- Profile: https://github.com/cbg-ethz
Beerenwinkel Lab at ETH Zurich
GitHub Events
Total
- Issues event: 8
- Watch event: 3
- Issue comment event: 2
Last Year
- Issues event: 8
- Watch event: 3
- Issue comment event: 2
Committers
Last synced: over 1 year ago
Top Committers
| Name | Commits | |
|---|---|---|
| armintoepfer | a****r@g****m | 235 |
| XLR | 2 | |
| toepfera | a****r@b****h | 1 |
Committer Domains (Top 20 + Academic)
Issues and Pull Requests
Last synced: 12 months ago
All Time
- Total issues: 9
- Total pull requests: 1
- Average time to close issues: over 2 years
- Average time to close pull requests: N/A
- Total issue authors: 8
- Total pull request authors: 1
- Average comments per issue: 1.11
- Average comments per pull request: 0.0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Past Year
- Issues: 2
- Pull requests: 0
- Average time to close issues: about 3 hours
- Average time to close pull requests: N/A
- Issue authors: 1
- Pull request authors: 0
- Average comments per issue: 1.5
- Average comments per pull request: 0
- Merged pull requests: 0
- Bot issues: 0
- Bot pull requests: 0
Top Authors
Issue Authors
- antonkratz (2)
- mhopken (1)
- sekhwal (1)
- LauraVP1994 (1)
- jblamyatifremer (1)
- DrYak (1)
- kali1819 (1)
- riccardomurri (1)
Pull Request Authors
- g1o (1)
Top Labels
Issue Labels
Pull Request Labels
Dependencies
- args4j:args4j 2.0.16 compile
- com.google.guava:guava 13.0.1
- commons-math:commons-math 1.2
- net.sf.trove4j:trove4j 2.0.2
- net.sf:samtools 1.108
- org.javatuples:javatuples 1.2
- junit:junit 4.10 test