Skip to main content

Distilled and Refined Annotation of Metabolism: A tool for the annotation and curation of function for microbial and viral genomes

Project description

DRAM

Build Status

DRAM (Distilled and Refined Annotation of Metabolism) is a tool for annotating metagenomic assembled genomes and VirSorter identified viral contigs. DRAM annotates MAGs and viral contigs using KEGG (if provided by the user), UniRef90, PFAM, dbCAN, RefSeq viral, VOGDB and the MEROPS peptidase database as well as custom user databases. DRAM is run in two stages. First an annotation step to assign database identifiers to gene and then a distill step to curate these annotations into useful functional categories. Additionally viral contigs are further analyzed during to identify potential AMGs. This is done via assigning an auxiliary score and flags representing the confidence that a gene is both metabolic and viral.

For more detail on DRAM and how DRAM works please see the wiki: https://github.com/shafferm/DRAM/wiki

Installation

To install DRAM some dependencies need to be installed first then DRAM can be installed from this repository. In the future DRAM will be available via both pip and conda.

  1. Install Dependencies

    Dependencies can be installed via conda or manually.

    Conda Installation

    Installed DRAM into a new conda environment using the provided enviornment.yaml file.

    wget https://raw.githubusercontent.com/shafferm/DRAM/master/environment.yaml
    conda env create -f environment.yaml -n DRAM
    

    If this installation method is used then all further steps should be run inside the newly created DRAM environment. This environment can be activated using this command:

    conda activate DRAM
    

    Manual Installation

    If you do not install via a conda enviornment, then the dependencies pandas, networkx, scikit-bio, prodigal, mmseqs2, hmmer and tRNAscan-SE need to be installed manually.

  2. Download this repository using git clone https://github.com/shafferm/DRAM.git

  3. Change directory into the DRAM directory and install DRAM using pip install -e .

You have now installed DRAM.

Setup

To run DRAM you need to set up the required databases in order to get annotations. All databases except for KEGG can be downloaded and set up for use with DRAM for you automatically. In order to get KEGG gene annotations and you must have access to the KEGG database. KEGG is a paid subscription service to download the protein files used by this annotator. If you do not have access to KEGG then DRAM will automatically use the KOfam HMM database to get KEGG Orthology identifiers.

I have access to KEGG

Set up DRAM using the following command:

DRAM-setup.py prepare_databases --output_dir DRAM_data --kegg_loc kegg.pep

kegg.pep is the path to the amino acid FASTA file downloaded from KEGG. This can be any of the gene fasta files that are provided by the KEGG FTP server or a concatenated version of them. DRAM_data is the path to the processed databases used by DRAM. If you already have any of the databases downloaded to your server and don't want to download them again then you can pass them to the prepare_databases command by use the --{db_name}_loc flags such as --uniref_loc and --viral_loc.

I don't have access to KEGG

Not a problem. Then use this command:

DRAM-setup.py prepare_databases --output_dir DRAM_data

Similar to above you can still provide locations of databases you have already downloaded so you don't have to do it again.

To test that your set up worked use the command DRAM.py print_config and the location of all databases provided will be shown as well as the presence of additional annotation information.

NOTE: Setting up DRAM can take a long time (up to 5 hours) depending on the number of processors which you tell it to use (using the --threads argument) and the speed of your internet connection. On my university server using 10 processors it takes about 2 hours to process the data when databases do not need to be downloaded.

Usage

Once DRAM is set up you are ready to annotate some MAGs. The following command will generate your full annotation:

DRAM.py annotate -i 'my_bins/*.fa' -o annotation

my_bins should be replaced with the path to a directory which contains all of your bins you would like to annotated and .fa should be replaced with the file extension used for your bins (i.e. .fasta, .fna, etc). If you only need to annotated a single genome (or an entire assembly) a direct path to a nucleotide fasta should be provided. Using 20 processors DRAM.py takes about 17 hours to annotate ~80 MAGs of medium quality or higher from a mouse gut metagenome.

In the output annotation folder there will be various files. genes.faa and genes.fna are fasta files with all genes called by prodigal with additional header information gained from the annotation as nucleotide and amino acid records respectively. genes.gff is a GFF3 with the same annotation information as well as gene locations. scaffolds.fna is a collection of all scaffolds/contigs given as input to DRAM.py annotate with added bin information in the headers. annotations.tsv is the most important output of the annotation. This includes all annotation information about every gene from all MAGs. Each line is a different gene and each column contains annotation information. trnas.tsv contains a summary of the tRNAs found in each MAG.

Then after your annotation is finished you can summarize these annotations with the following command:

DRAM.py distill -i annotation/annotations.tsv -o genome_summaries --trna_path annotation/trnas.tsv --rrna_path --rrna_path annotation/rrnas.tsv

This will generate the distillate and liquor files.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for DRAM-bio, version 1.0.1
Filename, size File type Python version Upload date Hashes
Filename, size DRAM-bio-1.0.1.tar.gz (65.2 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page