QuaTradis (Quadram TraDis)

A set of tools to analyse the output from TraDIS analyses

Contents

• Introduction
• Installation
  • Required dependencies
  • Bioconda
  • Docker
  • Running the tests
• Usage
  • Scripts
  • Analysis Scripts
  • Internal Objects and Methods
  • Perl Programming Examples
• License
• Feedback/Issues
• Citation

Introduction

The QuaTradis pipeline provides software utilities for the processing, mapping, and analysis of transposon insertion sequencing data. The pipeline was designed with the data from the TraDIS sequencing protocol in mind, but should work with a variety of transposon insertion sequencing protocols as long as they produce data in the expected format.

For more information on the TraDIS method, see http://bioinformatics.oxfordjournals.org/content/32/7/1109 and http://genome.cshlp.org/content/19/12/2308.

Installation

QuaTradis has the following dependencies:

Required dependencies

• bwa
• smalt
• samtools
• tabix

There are a number of ways to install QuaTradis and details are provided below. If you encounter an issue when installing QuaTradis please contact your local system administrator.

Bioconda

Install conda and enable the bioconda channel.

conda install -c bioconda quatradis=xxx

Docker

QuaTradis can be run in a Docker container. First install Docker, then pull the QuaTradis image from dockerhub:

docker pull quadraminstitute/quatradis

To use QuaTradis use a command like this (substituting in your directories), where your files are assumed to be stored in /home/ubuntu/data:

docker run --rm -it -v /home/ubuntu/data:/data quadraminstitute/quatradis bacteria_tradis -h

Running the tests

The test can be run with pytest from the tests directory. Alternatively you can use the make target from the top-level directory:

make test

Usage

QuaTradis provides functionality to:

• detect TraDIS tags in a BAM file
• add the tags to the reads
• filter reads in a FastQ file containing a user defined tag
• remove tags
• map to a reference genome
• create an insertion site plot file

The functions are available as standalone scripts or as perl modules.

Scripts

Executable scripts to carry out most of the listed functions are available in the bin:

• check_tradis_tags – Prints 1 if tags are present in alignment file, prints 0 if not.
• add_tradis_tags – Generates a BAM file with tags added to read strings.
• filter_tradis_tags – Create a fastq file containing reads that match the supplied tag
• remove_tradis_tags – Creates a fastq file containing reads with the supplied tag removed from the sequences
• tradis_plot – Creates an gzipped insertion site plot
• bacteria_tradis – Runs complete analysis, starting with a fastq file and produces mapped BAM files and plot files for each file in the given file list and a statistical summary of all files. Note that the -f option expects a text file containing a list of fastq files, one per line. This script can be run with or without supplying tags.

Note that default parameters are for comparative experiments, and will need to be modified for gene essentiality studies.

A help menu for each script can be accessed by running the script by adding with “–help”.

Analysis Scripts

Three scripts are provided to perform basic analysis of TraDIS results in bin:

• tradis_gene_insert_sites – Takes genome annotation in embl format along with plot files produced by bacteria_tradis and generates tab-delimited files containing gene-wise annotations of insert sites and read counts.
• tradis_essentiality.R – Takes a single tab-delimited file from tradis_gene_insert_sites to produce calls of gene essentiality. Also produces a number of diagnostic plots.
• tradis_comparison.R – Takes tab files to compare two growth conditions using edgeR. This analysis requires experimental replicates.

License

QuaTradis is free software, licensed under GPLv3.

Feedback/Issues

Please report any issues to the issues page or email [email protected]

Citation

If you use this software please cite:

“The TraDIS toolkit: sequencing and analysis for dense transposon mutant libraries”, Barquist L, Mayho M, Cummins C, Cain AK, Boinett CJ, Page AJ, Langridge G, Quail MA, Keane JA, Parkhill J. Bioinformatics. 2016 Apr 1;32(7):1109-11. doi: 10.1093/bioinformatics/btw022. Epub 2016 Jan 21.

GitHub

View Github