{"id":3705,"date":"2019-07-26T16:24:36","date_gmt":"2019-07-26T15:24:36","guid":{"rendered":"http:\/\/ri.itservices.manchester.ac.uk\/csf3\/?page_id=3705"},"modified":"2019-07-26T16:28:29","modified_gmt":"2019-07-26T15:28:29","slug":"kaiju","status":"publish","type":"page","link":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/software\/applications\/kaiju\/","title":{"rendered":"Kaiju"},"content":{"rendered":"<h2>Overview<\/h2>\n<p><a href=\"https:\/\/github.com\/bioinformatics-centre\/kaiju\">Kaiju<\/a> is a program for the taxonomic classification of high-throughput sequencing reads, e.g., Illumina or Roche\/454, from whole-genome sequencing of metagenomic DNA. Reads are directly assigned to taxa using the NCBI taxonomy and a reference database of protein sequences from microbial and viral genomes.<\/p>\n<p>Version 1.7.2 is installed on the CSF.<\/p>\n<h2>Restrictions on use<\/h2>\n<p>Details of the licence, restrictions, links to licence docs etc<br \/>\nThere are no restrictions on accessing the software on the CSF. It is released under the GNU GPL v3 license and all usage must adhere to that license.<\/p>\n<p>Please cite you use of this software using the reference:<\/p>\n<ul>\n<li>The program is described in <a href=\"http:\/\/www.nature.com\/ncomms\/2016\/160413\/ncomms11257\/full\/ncomms11257.html\">Menzel, P. et al. (2016) Fast and sensitive taxonomic classification for metagenomics with Kaiju. Nat. Commun. 7:11257<\/a> (open access).<\/li>\n<\/ul>\n<h2>Set up procedure<\/h2>\n<p>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 <abbr title=\"add '#$ -V' to your jobscript\">inherit these settings<\/abbr>.<\/p>\n<p>Load one of the following modulefiles:<\/p>\n<pre>\r\nmodule load apps\/gcc\/kaiju\/1.7.2\r\n<\/pre>\n<h2>Running the application<\/h2>\n<p>Please do not run Kaiju on the login node. Jobs should be submitted to the compute nodes via batch.<\/p>\n<p>You <em>may<\/em> run the commands with the <code>-h<\/code> flag to see a list of flags accepted by the program. For example:<\/p>\n<pre>\r\nkaiju -h\r\nkaiju-makedb -h\r\n<\/pre>\n<p>Note that kaiju is capable of downloading reference datasets and processing them to create the reference databases. This <strong>MUST<\/strong> be done as a batch job and you must inform the <code>kaiju-makedb<\/code> app how many cores your jobscript has requested (see below). By default <code>kaiju-makedb<\/code> uses 5 cores so if in doubt, submit a 5-core job. See the examples below for how to run the various executables correctly.<\/p>\n<h3>Serial batch job submission<\/h3>\n<p>Create a batch submission script (which will load the modulefile in the jobscript), for example:<\/p>\n<pre>\r\n#!\/bin\/bash --login\r\n#$ -cwd             # Job will run from the current directory\r\n                    # NO -V line - we load modulefiles in the jobscript\r\n\r\n# Load the modulefile in the jobscript - use your required version\r\nmodule load apps\/gcc\/kaiju\/1.7.2\r\n\r\n# There are various commands that can be run\r\nkaiju -t <em>nodes.dmp<\/em> -f <em>db.fmi<\/em> -i <em>reads.fastq<\/em> -j <em>reads2.fastq<\/em>\r\n\r\n# When making a database (this is best done with a parallel job - see below)\r\nkaiju-makedb -t $NSLOTS -s <em>source_db<\/em>\r\n<\/pre>\n<p>Submit the jobscript using: <\/p>\n<pre>qsub <em>scriptname<\/em><\/pre>\n<p>where <em>scriptname<\/em> is the name of your jobscript.<\/p>\n<h3>Parallel batch job submission<\/h3>\n<p>Create a batch submission script (which will load the modulefile in the jobscript), for example:<\/p>\n<pre>\r\n#!\/bin\/bash --login\r\n#$ -cwd             # Job will run from the current directory\r\n#$ -pe smp.pe 8     # Number of cores, can be 2 -- 32\r\n\r\n# Load the modulefile in the jobscript - use your required version\r\nmodule load apps\/gcc\/kaiju\/1.7.2\r\n\r\n# There are various commands that can be run. The flag to say how\r\n# many cores to use varies from app to app so you should look this up.\r\n# $NSLOTS is automatically set to the number of cores requested above.\r\n\r\n# Some examples:\r\nkaiju -z $NSLOTS -t <em>nodes.dmp<\/em> -f <em>db.fmi<\/em> -i <em>reads.fastq<\/em> ...\r\nkaijup -z $NSLOTS -f <em>proteins.fmi<\/em> -i <em>reads.fastq<\/em>\r\nkaijux -z $NSLOTS -f <em>proteins.fmi<\/em> -i <em>reads.fastq<\/em> ...\r\nkaiju-mergeOutputs -i <em>in1.tsv<\/em> -j <em>in2.tsv<\/em> .....\r\nkaiju-mkfmi <em>filename<\/em>     # Will read <em>filename<\/em>.bwt and <em>filename<\/em>.sa\r\nkaiju-mkbwt -n $NSLOTS <em>args<\/em> <em>filename<\/em>\r\nkaiju2krona -t <em>nodes.dmp<\/em> -n <em>names.dmp<\/em> -i <em>kaiju.out<\/em> -o <em>kaiju2krona.out<\/em>\r\nkaiju-convertNR -t <em>nodes.dmp<\/em> -g <em>prot.accession2taxid<\/em> -i <em>nr<\/em>\r\n\r\n# When making a database\r\nkaiju-makedb -t $NSLOTS -s <em>source_db<\/em>\r\n<\/pre>\n<p>Submit the jobscript using: <\/p>\n<pre>qsub <em>scriptname<\/em><\/pre>\n<p>where <em>scriptname<\/em> is the name of your jobscript.<\/p>\n<h2>Further info<\/h2>\n<ul>\n<li><a href=\"https:\/\/github.com\/bioinformatics-centre\/kaiju\">Kaiju website<\/a><\/li>\n<\/ul>\n<h2>Updates<\/h2>\n<p>None.<\/p>\n","protected":false},"excerpt":{"rendered":"<p>Overview Kaiju is a program for the taxonomic classification of high-throughput sequencing reads, e.g., Illumina or Roche\/454, from whole-genome sequencing of metagenomic DNA. Reads are directly assigned to taxa using the NCBI taxonomy and a reference database of protein sequences from microbial and viral genomes. Version 1.7.2 is installed on the CSF. Restrictions on use Details of the licence, restrictions, links to licence docs etc There are no restrictions on accessing the software on the.. <a href=\"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/software\/applications\/kaiju\/\">Read more &raquo;<\/a><\/p>\n","protected":false},"author":2,"featured_media":0,"parent":86,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-3705","page","type-page","status-publish","hentry"],"_links":{"self":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/3705","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages"}],"about":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/users\/2"}],"replies":[{"embeddable":true,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/comments?post=3705"}],"version-history":[{"count":4,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/3705\/revisions"}],"predecessor-version":[{"id":3710,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/3705\/revisions\/3710"}],"up":[{"embeddable":true,"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/pages\/86"}],"wp:attachment":[{"href":"https:\/\/ri.itservices.manchester.ac.uk\/csf3\/wp-json\/wp\/v2\/media?parent=3705"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}