HoloVir is a robust and flexible data analysis pipeline that provides an optimised and validated workflow for taxonomic and functional characterisation of viral metagenomes
Shell Python Perl
Latest commit 1dbf8fa Apr 25, 2016 @dturaev dturaev format fixes
Permalink
Failed to load latest commit information.
bin
db
scripts
README.md
configfile.txt

README.md

HoloVir 1.0

HoloVir is a robust and flexible data analysis pipeline that provides an optimised and validated workflow for taxonomic and functional characterisation of viral metagenomes

Dependencies

Given version are those tested; HoloVir might also work with other tool versions.

Usage

Create an empty project directory. Copy the configfile.txt (with all necessary paths and file names) into it. Copy or symlink the folders bin, scripts and db into it. The bin folder contains scripts which should be run in succession:

00preprocessing -> 01refseqreads, 02markerreads, 03assembly -> 04geneprediction -> 05refseqgenes, 06markergenes, 07swissprotgenes, 08eggnoggenes.

Some scripts can be run simultaneously (separated by comma), while others need to be run after the previous step finished (separated by arrow). The bin scripts are run without arguments from the created project directory.

The HoloVir manuscript reports the use of CLC Genomics Workbench for sequence preprocessing and assembly steps. If users have access to this commercial software, the configfile can be adjusted to CLC genomics workbench preprocessing and assembly to the subsequent components of HoloVir. As an alternative, freely available tools have been included to complete sequence QC, preprocessing and assembly (FastQC, Pear and BBMAP for quality control and sequence preprocessing steps; Trinity and Ray for assembly).

HoloVir has been written to submit batch jobs to Slurm workload manager. If an alternative workload manager is required, scripts that make use of SLURM need to be modified accordingly. These are all scripts in the bin/ directory and a number of scripts in the scripts/ directory (they contain instructions like #SBATCH or sbatch).