Breseq
Overview
Breseq is a computational pipeline for finding mutations relative to a reference sequence in short-read DNA re-sequencing data for haploid microbial-sized genomes. It is a command line tool implemented in C++ and R.
Version 0.38.1 is installed on the CSF.
Restrictions on use
Breseq is released under the GPL v2 License. There are no restrictions on accessing this software on the CSF but all usage must adhere to the license.
Please cite your usage of Breseq.
Set up procedure
We now recommend loading modulefiles within your jobscript so that you have a full record of how the job was run. See the example jobscript below for how to do this. Alternatively, you may load modulefiles on the login node and let the job inherit these settings.
Load one of the following modulefiles:
module load apps/binapps/breseq/0.38.1
If you need to use bowtie2 in conjunction with breseq, please see the installed bowtie versions on the CSF. You may need to load one of the modulefiles listed there too.
Running the application
Please do not run breseq on the login node to perform computational work. Jobs should be submitted to the compute nodes via batch.
You can run it on the login nodes to obtain the help text:
breseq --help
Serial batch job submission
Create a batch submission script (which will load the modulefile in the jobscript), for example:
#!/bin/bash --login #$ -cwd # Job will run from the current directory # NO -V line - we load modulefiles in the jobscript # Load the version you require module load apps/binapps/breseq/0.38.1 # By default breseq will use 1 CPU core, which is correct for a serial job breseq arg1 arg2 ...
Submit the jobscript using:
qsub scriptname
where scriptname is the name of your jobscript.
Parallel batch job submission
Breseq can be run using multiple CPU cores. This should reduce solution time and also give you access to more memory. Create a jobscript similar to the following:
#!/bin/bash --login #$ -cwd #$ -pe smp.pe 8 # Number of cores. Can be 2 -- 32. # Load the version you require module load apps/binapps/breseq/0.38.1 # Breseq uses the -j flag to specify the number of cores to use. # $NSLOTS will be set automatically to the number given above on the pe line breseq -j $NSLOTS arg1 arg2 ...
Submit the jobscript using:
qsub scriptname
where scriptname is the name of your jobscript.
High Memory Jobs
If you require more memory for your processing, please see the high memory jobs page.
Further info
Updates
None.