Skip to content
MetaCompass: Reference-guided Assembly of Metagenomes
Branch: master
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
MetaCompass.wiki
bin
docker
docs
images
snakemake
src
tutorial
utils
workflows
.gitignore
LICENSE
README.md
go_metacompass.py skip unnecessary software checks (-r) Apr 9, 2019
install.sh

README.md

MetaCompass v1.3

Last updated: April 6th, 2019

Publication

Victoria Cepeda, Bo Liu, Mathieu Almeida, Christopher M. Hill, Sergey Koren, Todd J. Treangen, Mihai Pop. bioRxiv 212506; doi: https://doi.org/10.1101/212506

Required software:

Memory and Disk Space Requirements.

You must have at least 13GB of hard disk space to perform a normal installation. You must have 8GB or more memory to allocate to the JVM (used by pilon).

INSTALLATION From Source (RECOMMENDED):

Get the Latest release from https://github.com/marbl/MetaCompass/releases:

wget https://github.com/marbl/MetaCompass/archive/1.xx.tar.gz
tar -xzvf 1.xx.tar.gz
cd MetaCompass-1.xx
./install.sh

INSTALLATION Using Git:

git clone https://github.com/marbl/MetaCompass.git
cd MetaCompass
./install.sh

USAGE

-- I have a set of metagenomic reads, and want to perform reference-guided assembly.

python3 go_metacompass.py -P [read1.fq,read2.fq] -l [max read length]-o [output_folder] -m [min coverage] -t [ncpu]

-- I know the reference genomes, or I want to perform comparative assembly for a particular genome.

python3 go_metacompass.py -r [references.fasta] -P [read1.fq,read2.fq] -o [output_folder] -m [min coverage] -t [ncpu]

OUTPUT

--Output folder contains the following files:

1) metacompass_output folder:
     - Assembled contigs:
            metacompass_output/metacompass.final.ctg.fa
     - Selected Reference genomes sequences:
            metacompass_output/metacompass.recruited.fa  
     - Selected Reference genomes ids and taxonomy ids
            metacompass_output/metacompass.recruited.ids
2) metacompass.tsv file with the following information: 
     - contig ID
     - contig size
     - reference genome used (only reference-guided assembled contigs)
     - name of the genome  

EXAMPLES

Reference-guided assembly with known reference genomes (no reference selection).

-- Input data is available in the tutorial folder:

Reference genome file:  Candidatus_Carsonella_ruddii_HT_Thao2000.fasta
Metagenomic reads:      thao2000.1.fq
                        thao2000.2.fq	

-- Run:

 python3 go_metacompass.py -r tutorial/Candidatus_Carsonella_ruddii_HT_Thao2000.fasta -P tutorial/thao2000.1.fq,tutorial/thao2000.2.fq -l 150 -o example1_output -m 1 -t 4

Reference-guided assembly with reference selection.

-- Download and extract metagenomic sample:

ftp://public-ftp.hmpdacc.org/Illumina/posterior_fornix/SRS044742.tar.bz2

SRS044742/
    SRS044742.denovo_duplicates_marked.trimmed.1.fastq
    SRS044742.denovo_duplicates_marked.trimmed.2.fastq
    SRS044742.denovo_duplicates_marked.trimmed.singleton.fastq

-- Run:

 python3 go_metacompass.py -P SRS044742/SRS044742.denovo_duplicates_marked.trimmed.1.fastq,SRS044742/SRS044742.denovo_duplicates_marked.trimmed.2.fastq -U SRS044742/SRS044742.denovo_duplicates_marked.trimmed.singleton.fastq -l 100 -o example2_output

Contact: vcepeda@cs.umd.edu

You can’t perform that action at this time.