GROOT is a tool to type Antibiotic Resistance Genes (ARGs) in metagenomic samples. It combines variation graph representation of gene sets with an LSH indexing scheme to allow for fast classification of metagenomic reads. Subsequent hierarchical local alignment of classified reads against graph traversals facilitates accurate reconstruction of full-length gene sequences using a simple scoring scheme.
GROOT will output an ARG alignment file (in BAM format) that contains the graph traversals possible for each query read; the alignment file is then used to generate a simple ARG typing report.
Check out the releases to download a binary. Alternatively, install using Bioconda or compile the software from source.
conda install groot
note: if using Conda make sure you have added the Bioconda channel first
GROOT is written in Go (v1.9) - to compile from source you will first need the Go tool chain. Once you have it, try something like this to compile:
# Clone this repository
git clone https://github.com/will-rowe/groot.git
# Go into the repository and get the package dependencies
cd groot
go get -d -t -v ./...
# Compile the program
go build ./
# Call the program
./groot --helpGROOT is called by typing groot, followed by the subcommand you wish to run. There are three main subcommands: index, align and report. This quick start will show you how to get things running but it is recommended to follow the documentation.
# Get a pre-clustered ARG database
groot get -d arg-annot
# Create graphs and index
groot index -i arg-annot.90 -o groot-index -l 100
# Align reads and report
groot align -i groot-index -f reads.fq | groot reportnote: you must run the index subcommand using your query read length (e.g.
-l 100for 100bp reads)
Please readthedocs for more extensive documentation and a tutorial.
We also have a preprint paper describing GROOT: