annotate mosaik2.xml @ 1:1fea05cdc1a1 draft default tip

Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
author crs4
date Thu, 06 Nov 2014 13:20:15 -0500
parents 6adb6e16b00f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
1 <?xml version="1.0"?>
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
2 <tool id="mosaik2" name="Map with MOSAIK v. 2" version="2.2.28.0">
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
3 <description/>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
4 <requirements>
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
5 <requirement type="package" version="2.2.28">mosaik</requirement>
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
6 <requirement type="package" version="0.1.19">samtools</requirement>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
7 </requirements>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
8 <version_command>MosaikJump | sed -e 's/\x1b\[[[:digit:]]\{1,2\}\(;[[:digit:]]\{1,2\}\)\{0,1\}m//g' | sed -n 's/MosaikJump \([[:digit:].]\{1,\}\).*/\1/p'</version_command>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
9 <command>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
10 MosaikBuild -fr
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
11 #if $genomeSource.refGenomeSource == 'indexed'
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
12 ${genomeSource.indexReference.fields.path}
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
13 #else
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
14 ${genomeSource.historyReference}
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
15 #end if
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
16 -oa mosaik_ref_file;
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
17 MosaikBuild -q $reads
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
18 #if $paired.kind == 'single'
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
19 #set $ls_string = ''
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
20 #else
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
21 -q2 ${paired.reads2}
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
22 -mfl ${paired.mfl}
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
23 #set $ls_string = '-ls %s' % $paired.ls
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
24 #end if
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
25 -st $st -out mosaik_reads_file;
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
26 MosaikAligner -p \${GALAXY_SLOTS:-4} -ia mosaik_ref_file -in mosaik_reads_file -out mosaik_aligned_file -annpe \$MOSAIK_NETWORK_DIR/2.1.78.pe.ann -annse \$MOSAIK_NETWORK_DIR/2.1.78.se.ann $ls_string
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
27 #if str($mm)
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
28 -mm $mm
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
29 #end if
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
30 #if str($act)
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
31 -act $act
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
32 #end if
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
33 #if str($bw)
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
34 -bw $bw
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
35 #end if
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
36 #if str($mhp)
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
37 -mhp $mhp
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
38 #end if
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
39 -hs 15 &amp;&amp;
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
40 #if str($outFormat) == 'bam'
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
41 samtools sort -o mosaik_aligned_file.bam out_prefix &gt; $output
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
42 #else
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
43 samtools view mosaik_aligned_file.bam -o $output
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
44 #end if
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
45 </command>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
46 <inputs>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
47 <conditional name="genomeSource">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
48 <param name="refGenomeSource" type="select" label="Will you select a reference genome from your history or use a built-in index?">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
49 <option value="indexed">Use a built-in index</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
50 <option value="history">Use one from the history</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
51 </param>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
52 <when value="indexed">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
53 <param name="indexReference" type="select" label="Select a reference genome">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
54 <options from_data_table="mosaik_indexes">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
55 <filter type="sort_by" column="2" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
56 <validator type="no_options" message="No indexes are available" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
57 </options>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
58 </param>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
59 </when>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
60 <when value="history">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
61 <param format="fasta" name="historyReference" type="data" metadata_name="dbkey" label="Select a reference from history" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
62 </when>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
63 </conditional>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
64 <param name="st" type="select" label="Sequencing technology used">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
65 <option value="454">454</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
66 <option value="illumina">Illumina</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
67 <option value="solid">Solid</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
68 <option value="sanger">Sanger</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
69 <option value="helicos">Helicos</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
70 </param>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
71 <param format="fastq" name="reads" type="data" label="FASTQ reads file" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
72 <conditional name="paired">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
73 <param name="kind" type="select" label="Is this library mate-paired?">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
74 <option value="single">Single-end</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
75 <option value="paired">Paired-end</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
76 </param>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
77 <when value="single" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
78 <when value="paired">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
79 <param format="fastq" name="reads2" type="data" label="FASTQ 2nd mate" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
80 <param name="mfl" type="integer" value="200" label="Median fragment length" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
81 <param name="ls" type="integer" min="0" value="50" label="Local alignment search radius to rescue mates" help="A large value slows down performances" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
82 </when>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
83 </conditional>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
84 <param name="mm" type="integer" value="6" optional="true" label="Number of mismatches allowed per sequence" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
85 <param name="act" type="integer" value="35" optional="true" label="Alignment candidate threshold" help="Determines which hash regions will be aligned with Smith-Waterman" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
86 <param name="bw" type="integer" value="9" optional="true" label="Smith-Waterman band width" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
87 <param name="mhp" type="integer" value="100" optional="true" label="Maximum number of positions stored per seed" help="Number of places in the reference the aligner will try to place a particular hash" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
88 <param name="outFormat" type="select" label="Output format">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
89 <option value="sam">SAM</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
90 <option value="bam">BAM</option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
91 </param>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
92 </inputs>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
93 <outputs>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
94 <data format="sam" name="output">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
95 <change_format>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
96 <when input="outFormat" value="bam" format="bam" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
97 </change_format>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
98 <actions>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
99 <conditional name="genomeSource.refGenomeSource">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
100 <when value="indexed">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
101 <action type="metadata" name="dbkey">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
102 <option type="from_data_table" name="mosaik_indexes" column="1">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
103 <filter type="param_value" column="0" value="#" compare="startswith" keep="False" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
104 <filter type="param_value" ref="genomeSource.indexReference" column="0" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
105 </option>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
106 </action>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
107 </when>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
108 <when value="history">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
109 <action type="metadata" name="dbkey">
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
110 <option type="from_param" name="genomeSource.historyReference" param_attribute="dbkey" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
111 </action>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
112 </when>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
113 </conditional>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
114 </actions>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
115 </data>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
116 </outputs>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
117 <tests>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
118 <test>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
119 <param name="refGenomeSource" value="history" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
120 <param name="historyReference" ftype="fasta" value="mosaik_test_ref.fasta" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
121 <param name="st" value="454" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
122 <param name="reads" ftype="fastq" value="mosaik_test_input.fastq" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
123 <param name="kind" value="single" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
124 <param name="mm" value="6" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
125 <param name="act" value="35" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
126 <param name="bw" value="9" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
127 <param name="mhp" value="100" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
128 <param name="outFormat" value="sam" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
129 <output name="output" file="mosaik_test_out.sam" compare="sim_size" delta="0" />
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
130 </test>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
131 </tests>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
132 <help>
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
133 **What it does**
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
134
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
135 This tool uses `MOSAIK`_ v. 2 to align reads to a reference sequence.
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
136
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
137 **License and citation**
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
138
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
139 This Galaxy tool is Copyright © 2005-2013 Pennsylvania State University, © 2013-2014 `CRS4 Srl.`_ and is released under the `Academic Free License v. 3.0`_.
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
140
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
141 .. _CRS4 Srl.: http://www.crs4.it/
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
142 .. _Academic Free License v. 3.0: http://opensource.org/licenses/AFL-3.0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
143
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
144 You can use this tool only if you agree to the license terms of: `MOSAIK`_.
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
145
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
146 .. _MOSAIK: https://code.google.com/p/mosaik-aligner/
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
147
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
148 If you use this tool, please cite:
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
149
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
150 - |Cuccuru2014|_
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
151 - |Lee2014|_.
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
152
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
153 .. |Cuccuru2014| replace:: Cuccuru, G., Orsini, M., Pinna, A., Sbardellati, A., Soranzo, N., Travaglione, A., Uva, P., Zanetti, G., Fotia, G. (2014) Orione, a web-based framework for NGS analysis in microbiology. *Bioinformatics* 30(13), 1928-1929
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
154 .. _Cuccuru2014: http://bioinformatics.oxfordjournals.org/content/30/13/1928
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
155 .. |Lee2014| replace:: Lee, W.-P., *et al.* (2014) MOSAIK: A Hash-Based Algorithm for Accurate Next-Generation Sequencing Short-Read Mapping. *PLoS ONE* 9(3), e90581
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
156 .. _Lee2014: http://www.plosone.org/article/info:doi/10.1371/journal.pone.0090581
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
157 </help>
1
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
158 <citations>
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
159 <citation type="doi">10.1093/bioinformatics/btu135</citation>
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
160 <citation type="doi">10.1371/journal.pone.0090581</citation>
1fea05cdc1a1 Update Orione citation. Upgrade Mosaik dependency to v. 2.2.28 (2.2.30 is buggy, see https://github.com/wanpinglee/MOSAIK/issues/11 ). Use 2.1.78 neural networks. Add package_zlib_1_2_8 and package_samtools_0_1_19 dependencies. Add <citations>.
crs4
parents: 0
diff changeset
161 </citations>
0
6adb6e16b00f Uploaded
crs4
parents:
diff changeset
162 </tool>