annotate novocraft_wrapper.xml @ 3:c43f9a578e05 draft

Uploaded
author subazini
date Wed, 17 Dec 2014 10:17:19 -0500
parents 10216882180b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
10216882180b Uploaded
subazini
parents:
diff changeset
1 <tool id="novocraft_wrapper" name="Novocraft" version="3.00.02">
10216882180b Uploaded
subazini
parents:
diff changeset
2 <description>maps query reads onto the reference sequences</description>
10216882180b Uploaded
subazini
parents:
diff changeset
3 <command interpreter="python">
10216882180b Uploaded
subazini
parents:
diff changeset
4 novocraft_wrapper.py
10216882180b Uploaded
subazini
parents:
diff changeset
5 ## Parameters
10216882180b Uploaded
subazini
parents:
diff changeset
6 --settings=$params.settingsType
10216882180b Uploaded
subazini
parents:
diff changeset
7 #if $params.settingsType == "full":
10216882180b Uploaded
subazini
parents:
diff changeset
8 --align=${params.t}
10216882180b Uploaded
subazini
parents:
diff changeset
9 --open=${params.g}
10216882180b Uploaded
subazini
parents:
diff changeset
10 --extend=${params.x}
10216882180b Uploaded
subazini
parents:
diff changeset
11 --trunc=${params.n}
10216882180b Uploaded
subazini
parents:
diff changeset
12 --kmer=${params.k}
10216882180b Uploaded
subazini
parents:
diff changeset
13 --step=${params.s}
10216882180b Uploaded
subazini
parents:
diff changeset
14 --qual=${params.l}
10216882180b Uploaded
subazini
parents:
diff changeset
15 --repe=${params.m}
10216882180b Uploaded
subazini
parents:
diff changeset
16 --hclip=${params.H}
10216882180b Uploaded
subazini
parents:
diff changeset
17 --pam=$params.pairedEnd
10216882180b Uploaded
subazini
parents:
diff changeset
18 --sd=${params.d}
10216882180b Uploaded
subazini
parents:
diff changeset
19 --insert=${params.i}
10216882180b Uploaded
subazini
parents:
diff changeset
20 #end if
10216882180b Uploaded
subazini
parents:
diff changeset
21
10216882180b Uploaded
subazini
parents:
diff changeset
22 #if $genomeSource.refGenomeSource == "history":
10216882180b Uploaded
subazini
parents:
diff changeset
23 ##build index on the fly
10216882180b Uploaded
subazini
parents:
diff changeset
24 --refer="${genomeSource.refFile}"
10216882180b Uploaded
subazini
parents:
diff changeset
25 ##--dbkey=$dbkey
10216882180b Uploaded
subazini
parents:
diff changeset
26 #else:
10216882180b Uploaded
subazini
parents:
diff changeset
27 ##use precomputed indexes
10216882180b Uploaded
subazini
parents:
diff changeset
28 --ref1="${genomeSource.indices.fields.path}"
10216882180b Uploaded
subazini
parents:
diff changeset
29 ##--do_not_build_index
10216882180b Uploaded
subazini
parents:
diff changeset
30 #end if
10216882180b Uploaded
subazini
parents:
diff changeset
31
10216882180b Uploaded
subazini
parents:
diff changeset
32 ## input file(s)
10216882180b Uploaded
subazini
parents:
diff changeset
33 --input1=$paired.input1
10216882180b Uploaded
subazini
parents:
diff changeset
34 #if $paired.sPaired == "paired":
10216882180b Uploaded
subazini
parents:
diff changeset
35 --input2=$paired.input2
10216882180b Uploaded
subazini
parents:
diff changeset
36 #end if
10216882180b Uploaded
subazini
parents:
diff changeset
37
10216882180b Uploaded
subazini
parents:
diff changeset
38 ## Outputs.
10216882180b Uploaded
subazini
parents:
diff changeset
39 --output=$output
10216882180b Uploaded
subazini
parents:
diff changeset
40
10216882180b Uploaded
subazini
parents:
diff changeset
41 </command>
10216882180b Uploaded
subazini
parents:
diff changeset
42 <inputs>
10216882180b Uploaded
subazini
parents:
diff changeset
43 <conditional name="genomeSource">
10216882180b Uploaded
subazini
parents:
diff changeset
44 <param name="refGenomeSource" type="select" label="Select a reference genome from your history or use a built-in index?">
10216882180b Uploaded
subazini
parents:
diff changeset
45 <option value="indexed">Use a built-in index</option>
10216882180b Uploaded
subazini
parents:
diff changeset
46 <option value="history">Use one from the history</option>
10216882180b Uploaded
subazini
parents:
diff changeset
47 </param>
10216882180b Uploaded
subazini
parents:
diff changeset
48
10216882180b Uploaded
subazini
parents:
diff changeset
49 <when value="indexed">
10216882180b Uploaded
subazini
parents:
diff changeset
50 <param name="indices" type="select" label="Select a reference genome">
10216882180b Uploaded
subazini
parents:
diff changeset
51 <options from_data_table="novocraft_indexes">
10216882180b Uploaded
subazini
parents:
diff changeset
52 <filter type="sort_by" column="2" />
10216882180b Uploaded
subazini
parents:
diff changeset
53 <validator type="no_options" message="No indexes are available" />
10216882180b Uploaded
subazini
parents:
diff changeset
54 </options>
10216882180b Uploaded
subazini
parents:
diff changeset
55 </param>
10216882180b Uploaded
subazini
parents:
diff changeset
56 </when>
10216882180b Uploaded
subazini
parents:
diff changeset
57
10216882180b Uploaded
subazini
parents:
diff changeset
58 <when value="history">
10216882180b Uploaded
subazini
parents:
diff changeset
59 <param name="refFile" type="data" format="fasta" metadata_name="dbkey" label="Select a reference from history" />
10216882180b Uploaded
subazini
parents:
diff changeset
60 </when>
10216882180b Uploaded
subazini
parents:
diff changeset
61 </conditional>
10216882180b Uploaded
subazini
parents:
diff changeset
62
10216882180b Uploaded
subazini
parents:
diff changeset
63 <conditional name="paired">
10216882180b Uploaded
subazini
parents:
diff changeset
64 <param name="sPaired" type="select" label="Is this library mate-paired?">
10216882180b Uploaded
subazini
parents:
diff changeset
65 <option value="single">Single-end</option>
10216882180b Uploaded
subazini
parents:
diff changeset
66 <option value="paired">Paired-end</option>
10216882180b Uploaded
subazini
parents:
diff changeset
67 </param>
10216882180b Uploaded
subazini
parents:
diff changeset
68
10216882180b Uploaded
subazini
parents:
diff changeset
69 <when value="single">
10216882180b Uploaded
subazini
parents:
diff changeset
70 <param name="input1" type="data" format="fastq" label="FASTQ file" help="FASTQ with Sanger-scaled quality values (fastqsanger)" />
10216882180b Uploaded
subazini
parents:
diff changeset
71 </when>
10216882180b Uploaded
subazini
parents:
diff changeset
72 <when value="paired">
10216882180b Uploaded
subazini
parents:
diff changeset
73 <param name="input1" type="data" format="fastq" label="Forward FASTQ file" help="FASTQ with Sanger-scaled quality values (fastqsanger)" />
10216882180b Uploaded
subazini
parents:
diff changeset
74 <param name="input2" type="data" format="fastq" label="Reverse FASTQ file" help="FASTQ with Sanger-scaled quality values (fastqsanger)" />
10216882180b Uploaded
subazini
parents:
diff changeset
75 </when>
10216882180b Uploaded
subazini
parents:
diff changeset
76 </conditional>
10216882180b Uploaded
subazini
parents:
diff changeset
77 <conditional name="params">
10216882180b Uploaded
subazini
parents:
diff changeset
78 <param name="settingsType" type="select" label="Parameter Settings" help="You can use the default settings or set custom values for the parameters.">
10216882180b Uploaded
subazini
parents:
diff changeset
79 <option value="preSet">Use Defaults</option>
10216882180b Uploaded
subazini
parents:
diff changeset
80 <option value="full">Full parameter list</option>
10216882180b Uploaded
subazini
parents:
diff changeset
81 </param>
10216882180b Uploaded
subazini
parents:
diff changeset
82 <when value="preSet" />
10216882180b Uploaded
subazini
parents:
diff changeset
83 <!-- Full/advanced parameters. -->
10216882180b Uploaded
subazini
parents:
diff changeset
84 <when value="full">
10216882180b Uploaded
subazini
parents:
diff changeset
85 <!-- Indexing parameters -->
10216882180b Uploaded
subazini
parents:
diff changeset
86 <param name="k" type="text" value="13" label="k-mer length for the index" />
10216882180b Uploaded
subazini
parents:
diff changeset
87 <param name="s" type="text" value="2" label="step size for the index" />
10216882180b Uploaded
subazini
parents:
diff changeset
88 <!-- Alignment Scoring -->
10216882180b Uploaded
subazini
parents:
diff changeset
89 <param name="t" type="text" value="99" label="maximum alignment score" />
10216882180b Uploaded
subazini
parents:
diff changeset
90 <param name="g" type="text" value="40" label="Gap opening penalty" />
10216882180b Uploaded
subazini
parents:
diff changeset
91 <param name="x" type="text" value="6" label="Gap extending penalty" />
10216882180b Uploaded
subazini
parents:
diff changeset
92 <!-- Read preprocessing -->
10216882180b Uploaded
subazini
parents:
diff changeset
93 <param name="n" type="text" value="80" label="Truncate read to specified length" />
10216882180b Uploaded
subazini
parents:
diff changeset
94 <!-- Quality control -->
10216882180b Uploaded
subazini
parents:
diff changeset
95 <param name="l" type="text" value="50" label="minimum number of good quality bases" />
10216882180b Uploaded
subazini
parents:
diff changeset
96 <param name="m" type="text" value="20" label="Repeat filter" />
10216882180b Uploaded
subazini
parents:
diff changeset
97 <param name="H" type="text" value="2" label="Hard clip 3' bases" />
10216882180b Uploaded
subazini
parents:
diff changeset
98 <param name="pairedEnd" type="select" label="Paired End" >
10216882180b Uploaded
subazini
parents:
diff changeset
99 <option value="mp">MP</option>
10216882180b Uploaded
subazini
parents:
diff changeset
100 <option value="pe">PE</option>
10216882180b Uploaded
subazini
parents:
diff changeset
101 <option value="pp">++</option>
10216882180b Uploaded
subazini
parents:
diff changeset
102 <option value="pn">+-</option>
10216882180b Uploaded
subazini
parents:
diff changeset
103 <option value="np">-+</option>
10216882180b Uploaded
subazini
parents:
diff changeset
104 </param>
10216882180b Uploaded
subazini
parents:
diff changeset
105
10216882180b Uploaded
subazini
parents:
diff changeset
106 <param name="i" type="text" value="200" label="Insert size" />
10216882180b Uploaded
subazini
parents:
diff changeset
107 <param name="d" type="text" value="50" label="standard deviation" />
10216882180b Uploaded
subazini
parents:
diff changeset
108
10216882180b Uploaded
subazini
parents:
diff changeset
109 </when> <!-- full -->
10216882180b Uploaded
subazini
parents:
diff changeset
110 </conditional> <!-- params -->
10216882180b Uploaded
subazini
parents:
diff changeset
111
10216882180b Uploaded
subazini
parents:
diff changeset
112
10216882180b Uploaded
subazini
parents:
diff changeset
113 </inputs>
10216882180b Uploaded
subazini
parents:
diff changeset
114 <outputs>
10216882180b Uploaded
subazini
parents:
diff changeset
115 <data format="txt" name="output" label="${tool.name} on ${on_string}:"/>
10216882180b Uploaded
subazini
parents:
diff changeset
116 </outputs>
10216882180b Uploaded
subazini
parents:
diff changeset
117 <help>
10216882180b Uploaded
subazini
parents:
diff changeset
118
10216882180b Uploaded
subazini
parents:
diff changeset
119 **Novoalign**
10216882180b Uploaded
subazini
parents:
diff changeset
120
10216882180b Uploaded
subazini
parents:
diff changeset
121 Novoalign is highly accurate program for mapping next-generation sequencing reads to a reference database. (http://www.novocraft.com/). Selected parameters used here are listed here.
10216882180b Uploaded
subazini
parents:
diff changeset
122
10216882180b Uploaded
subazini
parents:
diff changeset
123 ------
10216882180b Uploaded
subazini
parents:
diff changeset
124
10216882180b Uploaded
subazini
parents:
diff changeset
125 **Indexing usage**
10216882180b Uploaded
subazini
parents:
diff changeset
126
10216882180b Uploaded
subazini
parents:
diff changeset
127 novoindex options indexfile sequencefiles
10216882180b Uploaded
subazini
parents:
diff changeset
128
10216882180b Uploaded
subazini
parents:
diff changeset
129 ------
10216882180b Uploaded
subazini
parents:
diff changeset
130
10216882180b Uploaded
subazini
parents:
diff changeset
131 **Options - Description**
10216882180b Uploaded
subazini
parents:
diff changeset
132
10216882180b Uploaded
subazini
parents:
diff changeset
133 -­k 99
10216882180b Uploaded
subazini
parents:
diff changeset
134
10216882180b Uploaded
subazini
parents:
diff changeset
135 k­mer length to be used for the index. Novoindex will select appropriate values if either of these is not specified. Default value is log4(N/20s) where N is genome size and s step size.
10216882180b Uploaded
subazini
parents:
diff changeset
136
10216882180b Uploaded
subazini
parents:
diff changeset
137 -s 9
10216882180b Uploaded
subazini
parents:
diff changeset
138
10216882180b Uploaded
subazini
parents:
diff changeset
139 step size for the index. Typical values are from 1 to 3, usually defaults to 1 or 2. Genomes larger than 4Gbp can be indexed using a stepsize > 1, the requirement is N/s less than 4G.
10216882180b Uploaded
subazini
parents:
diff changeset
140
10216882180b Uploaded
subazini
parents:
diff changeset
141 ------
10216882180b Uploaded
subazini
parents:
diff changeset
142
10216882180b Uploaded
subazini
parents:
diff changeset
143 **Alignment usage**
10216882180b Uploaded
subazini
parents:
diff changeset
144
10216882180b Uploaded
subazini
parents:
diff changeset
145 novoalign options
10216882180b Uploaded
subazini
parents:
diff changeset
146
10216882180b Uploaded
subazini
parents:
diff changeset
147 ------
10216882180b Uploaded
subazini
parents:
diff changeset
148
10216882180b Uploaded
subazini
parents:
diff changeset
149 **Options - Description**
10216882180b Uploaded
subazini
parents:
diff changeset
150
10216882180b Uploaded
subazini
parents:
diff changeset
151 -d dbname
10216882180b Uploaded
subazini
parents:
diff changeset
152
10216882180b Uploaded
subazini
parents:
diff changeset
153 Full pathname of indexed reference sequence from novoindex
10216882180b Uploaded
subazini
parents:
diff changeset
154
10216882180b Uploaded
subazini
parents:
diff changeset
155 -f read1 read2
10216882180b Uploaded
subazini
parents:
diff changeset
156
10216882180b Uploaded
subazini
parents:
diff changeset
157 Filenames for the read sequences for Side 1 and 2.
10216882180b Uploaded
subazini
parents:
diff changeset
158
10216882180b Uploaded
subazini
parents:
diff changeset
159 -­t 99
10216882180b Uploaded
subazini
parents:
diff changeset
160
10216882180b Uploaded
subazini
parents:
diff changeset
161 Sets absolute threshold or highest alignment score acceptable for the best alignment.
10216882180b Uploaded
subazini
parents:
diff changeset
162
10216882180b Uploaded
subazini
parents:
diff changeset
163 -g 99
10216882180b Uploaded
subazini
parents:
diff changeset
164
10216882180b Uploaded
subazini
parents:
diff changeset
165 Sets the gap opening penalty. Default 40
10216882180b Uploaded
subazini
parents:
diff changeset
166
10216882180b Uploaded
subazini
parents:
diff changeset
167 -­x 99
10216882180b Uploaded
subazini
parents:
diff changeset
168
10216882180b Uploaded
subazini
parents:
diff changeset
169 Sets the gap extend penalty. Default 6
10216882180b Uploaded
subazini
parents:
diff changeset
170
10216882180b Uploaded
subazini
parents:
diff changeset
171 -­l 99
10216882180b Uploaded
subazini
parents:
diff changeset
172
10216882180b Uploaded
subazini
parents:
diff changeset
173 Sets the minimum number of good quality bases for a read.
10216882180b Uploaded
subazini
parents:
diff changeset
174
10216882180b Uploaded
subazini
parents:
diff changeset
175 -­H [99]
10216882180b Uploaded
subazini
parents:
diff changeset
176
10216882180b Uploaded
subazini
parents:
diff changeset
177 Hard clips 3' bases with quality &lt;=[99] from reads before aligning them.
10216882180b Uploaded
subazini
parents:
diff changeset
178
10216882180b Uploaded
subazini
parents:
diff changeset
179
10216882180b Uploaded
subazini
parents:
diff changeset
180
10216882180b Uploaded
subazini
parents:
diff changeset
181 </help>
10216882180b Uploaded
subazini
parents:
diff changeset
182
10216882180b Uploaded
subazini
parents:
diff changeset
183 </tool>
10216882180b Uploaded
subazini
parents:
diff changeset
184
10216882180b Uploaded
subazini
parents:
diff changeset
185
10216882180b Uploaded
subazini
parents:
diff changeset
186
10216882180b Uploaded
subazini
parents:
diff changeset
187
10216882180b Uploaded
subazini
parents:
diff changeset
188