Mercurial > repos > wolma > mimodd_core
comparison cloudmap.xml @ 0:aa82b2e54055 draft
planemo upload for repository https://github.com/wm75/mimodd_galaxy_wrappers commit b36048cd608ede0ec6f6559648525c9350caae34-dirty
author | wolma |
---|---|
date | Sat, 11 Nov 2017 18:19:22 -0500 |
parents | |
children | 1425ea794026 |
comparison
equal
deleted
inserted
replaced
-1:000000000000 | 0:aa82b2e54055 |
---|---|
1 <tool id="mimodd_map" name="MiModD NacreousMap" version="@MIMODD_WRAPPER_VERSION@"> | |
2 <description>maps phenotypically selected variants by multi-variant linkage analysis</description> | |
3 <macros> | |
4 <import>macros.xml</import> | |
5 <macro name="svd_unconditional"> | |
6 <expand macro="hidden_algo_params" /> | |
7 <expand macro="seqdict_param" /> | |
8 <expand macro="bins" /> | |
9 <conditional name="plotopts"> | |
10 <param name="plots" type="select" label="graphical output settings"> | |
11 <option value="-p">Give me graphics.</option> | |
12 <option value="">Do not generate graphs.</option> | |
13 </param> | |
14 <when value=""> | |
15 </when> | |
16 <when value="-p"> | |
17 <expand macro="scatter_default" /> | |
18 <param name="show_kde" type="boolean" truevalue="" falsevalue="--no-kde" checked="true" | |
19 label="show kde line in histogram plots" | |
20 help="The tool can calculate a kernel density estimate for the linkage data based on a bin size of 10 kilobases and display it as a solid line in the histogram plots." /> | |
21 <param name="hylim" type="text" | |
22 label="upper limit for the histogram y-axis (leave blank for automatic scaling)" /> | |
23 <param name="xlim" type="select" label="x-axis scaling"> | |
24 <option value="">preserve relative contig sizes</option> | |
25 <option value="--fit-width">scale each contig to fit the plot width</option> | |
26 </param> | |
27 <expand macro="hist_colors" /> | |
28 </when> | |
29 </conditional> | |
30 </macro> | |
31 <macro name="vaf_unconditional"> | |
32 <expand macro="bins" /> | |
33 <conditional name="plotopts"> | |
34 <param name="plots" type="select" label="graphical output settings"> | |
35 <option value="-p">Give me everything (scatter plots and histograms)</option> | |
36 <option value="--no-scatter -p">Generate only histograms</option> | |
37 <option value="--no-hist -p">Generate only scatter plots</option> | |
38 <option value="">Do not generate graphs.</option> | |
39 </param> | |
40 <when value=""> | |
41 </when> | |
42 <when value="--no-scatter -p"> | |
43 <expand macro="scatter_default" /> | |
44 <param name="show_kde" type="boolean" truevalue="" falsevalue="--no-kde" checked="true" | |
45 label="show kde line in histogram plots" | |
46 help="The tool can calculate a kernel density estimate for the linkage data based on a bin size of 10 kilobases and display it as a solid line in the histogram plots." /> | |
47 <param name="hylim" type="text" | |
48 label="upper limit for the histogram y-axis (leave blank for automatic scaling)" /> | |
49 <param name="xlim" type="select" label="x-axis scaling"> | |
50 <option value="">preserve relative contig sizes</option> | |
51 <option value="--fit-width">scale each contig to fit the plot width</option> | |
52 </param> | |
53 <expand macro="hist_colors" /> | |
54 </when> | |
55 <when value="--no-hist -p"> | |
56 <expand macro="hist_default" /> | |
57 <param name="sylim" type="text" | |
58 label="upper limit for the scatter plot y-axis (default: 1)" /> | |
59 <param name="xlim" type="select" label="x-axis scaling"> | |
60 <option value="">preserve relative contig sizes</option> | |
61 <option value="--fit-width">scale each contig to fit the plot width</option> | |
62 </param> | |
63 <param name="span" type="text" | |
64 label="span value to be used in calculating the Loess regression line through the scatter data (default=0.1, specify 0 to prevent calculation)" | |
65 help="smaller values give a more responsive curve that often picks up local evidence for tight linkage better, but too small values lead to plotting failures (in that case just rerun the tool with a larger value)." /> | |
66 <expand macro="scatter_colors" /> | |
67 </when> | |
68 <when value="-p"> | |
69 <expand macro="plot_all" /> | |
70 </when> | |
71 </conditional> | |
72 </macro> | |
73 <macro name="vac_unconditional"> | |
74 <expand macro="bins" /> | |
75 <conditional name="plotopts"> | |
76 <param name="plots" type="select" label="graphical output settings"> | |
77 <option value="--no-scatter -p">Give me graphical output</option> | |
78 <option value="">Do not generate graphs.</option> | |
79 </param> | |
80 <when value=""> | |
81 </when> | |
82 <when value="--no-scatter -p"> | |
83 <expand macro="scatter_default" /> | |
84 <param name="show_kde" type="boolean" truevalue="" falsevalue="--no-kde" checked="true" | |
85 label="show kde line in histogram plots" | |
86 help="The tool can calculate a kernel density estimate for the linkage data based on a bin size of 10 kilobases and display it as a solid line in the histogram plots." /> | |
87 <param name="hylim" type="text" | |
88 label="upper limit for the histogram y-axis (leave blank for automatic scaling)" /> | |
89 <param name="xlim" type="select" label="x-axis scaling"> | |
90 <option value="">preserve relative contig sizes</option> | |
91 <option value="--fit-width">scale each contig to fit the plot width</option> | |
92 </param> | |
93 <expand macro="hist_colors" /> | |
94 </when> | |
95 </conditional> | |
96 </macro> | |
97 <macro name="hidden_algo_params"> | |
98 <param name="sample" type="hidden" value="" /> | |
99 <expand macro="hidden_vaf_algo_params" /> | |
100 <param name="contrast_sample" type="hidden" value="" /> | |
101 </macro> | |
102 <macro name="hidden_vaf_algo_params"> | |
103 <param name="related_parent_sample" type="hidden" value="" /> | |
104 <param name="unrelated_parent_sample" type="hidden" value="" /> | |
105 <param name="infer_missing" type="hidden" value="" /> | |
106 </macro> | |
107 <macro name="bins"> | |
108 <repeat name="bin_sizes" default="0" min="0" title="bin sizes to analyze variants in (defaults to: 1Mb and 500Kb)" | |
109 help="Values can be entered in bases (e.g., 1000000), kilobases (e.g., 500Kb) or megabases (e.g., 1Mb), but must be integral, i.e. no decimal numbers are allowed."> | |
110 <param name="bin_size" type="text" /> | |
111 </repeat> | |
112 </macro> | |
113 <macro name="scatter_default"> | |
114 <param name="sylim" type="hidden" value="" /> | |
115 <param name="span" type="hidden" value="" /> | |
116 <param name="pcols" type="hidden" value="" /> | |
117 <param name="lcols" type="hidden" value="" /> | |
118 </macro> | |
119 <macro name="hist_default"> | |
120 <param name="show_kde" type="hidden" value="" /> | |
121 <param name="hylim" type="hidden" value="" /> | |
122 <param name="hcols" type="hidden" value="" /> | |
123 </macro> | |
124 <macro name="hist_colors"> | |
125 <repeat name="hcols" default="0" min="0" title="histogram colors" | |
126 help="For each bin size chosen above a histogram will be generated with its color selected from the list provided here (defaults to alternating darkgrey, red)."> | |
127 <param name="hcolor" type="color" value="darkgrey"> | |
128 <sanitizer><valid><add value="#" /></valid></sanitizer> | |
129 </param> | |
130 </repeat> | |
131 </macro> | |
132 <macro name="scatter_colors"> | |
133 <repeat name="pcols" default="0" min="0" title="data point colors" | |
134 help="Series of data points will be plotted based on the colors selected here."> | |
135 <param name="pcol" type="color" value="black"> | |
136 <sanitizer><valid><add value="#" /></valid></sanitizer> | |
137 </param> | |
138 </repeat> | |
139 <repeat name="lcols" default="0" min="0" | |
140 title="regression line colors" | |
141 help="Regression lines through series of data will be plotted in the colors selected here."> | |
142 <param name="lcol" type="color" value="red"> | |
143 <sanitizer><valid><add value="#" /></valid></sanitizer> | |
144 </param> | |
145 </repeat> | |
146 </macro> | |
147 <macro name="plot_all"> | |
148 <param name="show_kde" type="boolean" truevalue="" falsevalue="--no-kde" checked="true" | |
149 label="show kde line in histogram plots" | |
150 help="The tool can calculate a kernel density estimate for the linkage data based on a bin size of 10 kilobases and display it as a solid line in the histogram plots." /> | |
151 <param name="hylim" type="text" | |
152 label="upper limit for the histogram y-axis (leave blank for automatic scaling)" /> | |
153 <param name="sylim" type="text" | |
154 label="upper limit for the scatter plot y-axis (default: 1)" /> | |
155 <param name="xlim" type="select" label="x-axis scaling"> | |
156 <option value="">preserve relative contig sizes</option> | |
157 <option value="--fit-width">scale each contig to fit the plot width</option> | |
158 </param> | |
159 <param name="span" type="text" | |
160 label="span value to be used in calculating the Loess regression line through the scatter data (default=0.1, specify 0 to prevent calculation)" | |
161 help="smaller values give a more responsive curve that often picks up local evidence for tight linkage better, but too small values lead to plotting failures (in that case just rerun the tool with a larger value)." /> | |
162 <expand macro="hist_colors" /> | |
163 <expand macro="scatter_colors" /> | |
164 </macro> | |
165 <macro name="seqdict_param"> | |
166 <conditional name="seqinfo_external"> | |
167 <param name="source" type="select" | |
168 label="does this input provide contig name and size information?" | |
169 help="ALWAYS select 'yes' here if the input dataset was generated with MiModD. Input generated with third-party tools may or may not provide the information. If in doubt, execute the job with 'yes' selected and see if you are getting a corresponding error message."> | |
170 <option value="">Yes</option> | |
171 <option value="fasta">No, get the information from a reference genome in my history</option> | |
172 <option value="cached">No, get the information from a built-in genome</option> | |
173 <option value="seqdict">No, get the information from a CloudMap-style sequence dictionary in my history</option> | |
174 </param> | |
175 <when value="fasta"> | |
176 <param name="seqinfo" type="data" format="fasta" | |
177 label="Reference genome to extract contig info from" /> | |
178 </when> | |
179 <when value="cached"> | |
180 <param name="seqinfo" type="select" | |
181 label="Reference genome to extract contig info from"> | |
182 <options from_data_table="all_fasta" /> | |
183 </param> | |
184 </when> | |
185 <when value="seqdict"> | |
186 <param name="seqinfo" type="data" format="tabular" | |
187 label="CloudMap-style sequence dictionary to extract contig info from" /> | |
188 </when> | |
189 <when value=""> | |
190 </when> | |
191 </conditional> | |
192 </macro> | |
193 <macro name="test_tabular_out"> | |
194 <output name="ofile" ftype="tabular"> | |
195 <assert_contents> | |
196 <has_text text="chrI" /> | |
197 <has_text text="chrII" /> | |
198 <has_text text="chrIII" /> | |
199 <has_text text="chrIV" /> | |
200 <has_text text="chrV" /> | |
201 <has_text text="chrX" /> | |
202 <has_text text="MtDNA" /> | |
203 </assert_contents> | |
204 </output> | |
205 </macro> | |
206 </macros> | |
207 <expand macro="requirements" /> | |
208 <expand macro="stdio" /> | |
209 <expand macro="version_command" /> | |
210 <command><![CDATA[ | |
211 mimodd map ${opt.mode} "${opt.source.ifile}" | |
212 #if $str($opt.source.sample): | |
213 -m '${opt.source.sample}' | |
214 #end if | |
215 #if $str($opt.source.related_parent_sample): | |
216 -r '${opt.source.related_parent_sample}' | |
217 #end if | |
218 #if $str($opt.source.unrelated_parent_sample): | |
219 -u '${opt.source.unrelated_parent_sample}' | |
220 #end if | |
221 #if $str($opt.source.contrast_sample): | |
222 -c '${opt.source.contrast_sample}' | |
223 #end if | |
224 $opt.source.infer_missing | |
225 -o '$ofile' | |
226 #if $str($opt.source.seqinfo_external.source) in ("fasta", "seqdict"): | |
227 -s '${opt.source.seqinfo_external.seqinfo}' | |
228 #else if $str($opt.source.seqinfo_external.source) == "cached": | |
229 -s '${opt.source.seqinfo_external.seqinfo.fields.path}' | |
230 #end if | |
231 #if $len($opt.source.bin_sizes): | |
232 --bin-sizes | |
233 #for $size in $opt.source.bin_sizes: | |
234 '${size.bin_size}' | |
235 #end for | |
236 #end if | |
237 #if $str($opt.source.tabfile): | |
238 $str($opt.source.tabfile) '$tfile' | |
239 #end if | |
240 #if $str($opt.source.plotopts.plots): | |
241 $str($opt.source.plotopts.plots) '$pfile' | |
242 $opt.source.plotopts.show_kde | |
243 $str($opt.source.plotopts.xlim) | |
244 #if $str($opt.source.plotopts.hylim): | |
245 --ylim-hist $str($opt.source.plotopts.hylim) | |
246 #end if | |
247 #if $str($opt.source.plotopts.hcols) and $len($opt.source.plotopts.hcols): | |
248 --hist-colors | |
249 #for $color in $opt.source.plotopts.hcols: | |
250 '${color.hcolor}' | |
251 #end for | |
252 #end if | |
253 #if $str($opt.source.plotopts.sylim): | |
254 --ylim-scatter $str($opt.source.plotopts.sylim) | |
255 #end if | |
256 #if $str($opt.source.plotopts.pcols) and $len($opt.source.plotopts.pcols): | |
257 --points-colors | |
258 #for $color in $opt.source.plotopts.pcols: | |
259 '${color.pcol}' | |
260 #end for | |
261 #end if | |
262 #if $str($opt.source.plotopts.lcols) and $len($opt.source.plotopts.lcols): | |
263 --loess-colors | |
264 #for $color in $opt.source.plotopts.lcols: | |
265 '${color.lcol}' | |
266 #end for | |
267 #end if | |
268 #if $str($opt.source.plotopts.span): | |
269 --loess-span $str($opt.source.plotopts.span) | |
270 #end if | |
271 #end if | |
272 ]]></command> | |
273 | |
274 <inputs> | |
275 <conditional name="opt"> | |
276 <param name="mode" type="select" label="type of mapping analysis to perform" | |
277 help="Select Simple Variant Density (SVD) Mapping to map mutations based on linked inheritance in near isogenic populations, Variant Allele Frequency (VAF) Mapping for bulk segregant analysis. Select Reprocess for rapidly replotting the result of a previous VAF analysis."> | |
278 <option value="SVD">Simple Variant Density Mapping</option> | |
279 <option value="VAF">Variant Allele Frequency Mapping</option> | |
280 <option value="VAC">Variant Allele Contrast Mapping</option> | |
281 </param> | |
282 <when value="SVD"> | |
283 <conditional name="source"> | |
284 <param name="inputtype" type="select" label="data source to use"> | |
285 <option value="vcf">VCF file of variants (for de-novo mapping)</option> | |
286 <option value="rep">per-variant report file (for remapping a previous analysis)</option> | |
287 </param> | |
288 <when value="vcf"> | |
289 <param name="ifile" type="data" format="vcf" | |
290 label="input file with variants to analyze" /> | |
291 <expand macro="svd_unconditional" /> | |
292 <param name="tabfile" type="select" | |
293 label="additional per-variant output file" | |
294 help="You can either choose to produce a tabular per-variant report, which is useful for fast replotting with different plot settings, or a VCF-like CloudMap-compatibility output that can be used as input for the older CloudMap EMS Variant Density Mapping tool as an alternative plotting tool."> | |
295 <option value="">Do not generate per-variant output</option> | |
296 <option value="-t">Tabular per-variant report</option> | |
297 <option value="--cloudmap -t">CloudMap compatibility output</option> | |
298 </param> | |
299 </when> | |
300 <when value="rep"> | |
301 <param name="ifile" type="data" format="tabular,csv" | |
302 label="input file with variants to analyze" /> | |
303 <param name="tabfile" type="hidden" value="" /> | |
304 <expand macro="svd_unconditional" /> | |
305 </when> | |
306 </conditional> | |
307 </when> | |
308 <when value="VAF"> | |
309 <conditional name="source"> | |
310 <param name="inputtype" type="select" label="data source to use"> | |
311 <option value="vcf">VCF file of variants (for de-novo mapping)</option> | |
312 <option value="rep">per-variant report file (for remapping a previous analysis)</option> | |
313 </param> | |
314 <when value="vcf"> | |
315 <param name="ifile" type="data" format="vcf" | |
316 label="input file with variants to analyze" /> | |
317 <expand macro="seqdict_param" /> | |
318 <param name="sample" type="text" | |
319 label="mapping sample name" help="the sample to perform mutation mapping for"> | |
320 <validator type="empty_field" /> | |
321 </param> | |
322 <param name="related_parent_sample" type="text" | |
323 label="name of the related parent sample" | |
324 help="the sample that provides variants present in your original mutant strain or in an ancestor (like the pre-mutagenesis strain); leave blank if not available" /> | |
325 <param name="unrelated_parent_sample" type="text" | |
326 label="name of the unrelated parent sample" | |
327 help="the sample that provides variants present in the unrelated mapping strain (or in an ancestor of it) used in the mapping cross; leave blank if not available" /> | |
328 <param name="infer_missing" type="boolean" truevalue="--infer-missing" falsevalue="" checked="false" | |
329 label="Infer alleles for missing parent" | |
330 help="if variant data for either the related or the unrelated parent strain is not available, the tool can try to infer the alleles present in that parent from the allele spectrum found in the mapping sample. Use with caution on carefully filtered variant lists only!" /> | |
331 <param name="contrast_sample" type="hidden" value="" /> | |
332 <expand macro="vaf_unconditional" /> | |
333 <param name="tabfile" type="select" | |
334 label="additional per-variant output file" | |
335 help="You can either choose to produce a tabular per-variant report, which is useful for fast replotting with different plot settings, or a VCF-like CloudMap-compatibility output that can be used as input for the older CloudMap Hawaiian Variant Mapping tool as an alternative plotting tool."> | |
336 <option value="">Do not generate per-variant output</option> | |
337 <option value="-t">Tabular per-variant report</option> | |
338 <option value="--cloudmap -t">CloudMap compatibility output</option> | |
339 </param> | |
340 </when> | |
341 <when value="rep"> | |
342 <param name="ifile" type="data" format="tabular,csv" | |
343 label="input file with variants to analyze" /> | |
344 <expand macro="seqdict_param" /> | |
345 <param name="tabfile" type="hidden" value="" /> | |
346 <expand macro="hidden_algo_params" /> | |
347 <expand macro="vaf_unconditional" /> | |
348 </when> | |
349 </conditional> | |
350 </when> | |
351 <when value="VAC"> | |
352 <conditional name="source"> | |
353 <param name="inputtype" type="select" | |
354 label="data source to use"> | |
355 <option value="vcf">VCF file of variants (for de-novo mapping)</option> | |
356 <option value="rep">per-variant report file (for remapping a previous analysis)</option> | |
357 </param> | |
358 <when value="vcf"> | |
359 <param name="ifile" type="data" format="vcf" | |
360 label="input file with variants to analyze" /> | |
361 <expand macro="seqdict_param" /> | |
362 <expand macro="hidden_vaf_algo_params" /> | |
363 <param name="sample" type="text" | |
364 label="mapping sample name" | |
365 help="the sample to perform mutation mapping for"> | |
366 <validator type="empty_field" /> | |
367 </param> | |
368 <param name="contrast_sample" type="text" | |
369 label="name of the contrast sample" | |
370 help="the sample that provides contrasting allele composition around the causal variant"> | |
371 <validator type="empty_field" /> | |
372 </param> | |
373 <expand macro="vac_unconditional" /> | |
374 <param name="tabfile" type="select" | |
375 label="additional per-variant output file" | |
376 help="You can choose to produce a tabular per-variant report, which is useful for fast replotting with different plot settings."> | |
377 <option value="">Do not generate per-variant output</option> | |
378 <option value="-t">Tabular per-variant report</option> | |
379 </param> | |
380 </when> | |
381 <when value="rep"> | |
382 <param name="ifile" type="data" format="tabular,csv" | |
383 label="input file with variants to analyze" /> | |
384 <expand macro="seqdict_param" /> | |
385 <param name="tabfile" type="hidden" value="" /> | |
386 <expand macro="hidden_algo_params" /> | |
387 <expand macro="vac_unconditional" /> | |
388 </when> | |
389 </conditional> | |
390 </when> | |
391 </conditional> | |
392 </inputs> | |
393 <outputs> | |
394 <data name="ofile" format="tabular" | |
395 label="MiModD ${opt.mode} Mapping - binned variant counts for ${on_string}" /> | |
396 <data name="tfile" format="tabular" | |
397 label="MiModD ${opt.mode} Mapping - per-variant report for ${on_string}"> | |
398 <filter>(opt['source']['tabfile'])</filter> | |
399 </data> | |
400 <data name="pfile" format="pdf" | |
401 label="MiModD ${opt.mode} Mapping - linkage plots for ${on_string}"> | |
402 <filter>(opt['source']['plotopts']['plots'])</filter> | |
403 </data> | |
404 </outputs> | |
405 | |
406 <tests> | |
407 <test expect_num_outputs="1"> | |
408 <conditional name="opt"> | |
409 <param name="mode" value="SVD" /> | |
410 <conditional name="source"> | |
411 <param name="inputtype" value="vcf" /> | |
412 <conditional name="plotopts"> | |
413 <param name="plots" value="" /> | |
414 </conditional> | |
415 <param name="ifile" value="a.vcf" /> | |
416 </conditional> | |
417 </conditional> | |
418 <expand macro="test_tabular_out" /> | |
419 </test> | |
420 <test expect_num_outputs="2"> | |
421 <conditional name="opt"> | |
422 <param name="mode" value="VAF" /> | |
423 <conditional name="source"> | |
424 <param name="inputtype" value="vcf" /> | |
425 <conditional name="plotopts"> | |
426 <param name="plots" value="-p" /> | |
427 </conditional> | |
428 <param name="sample" value="ot266" /> | |
429 <param name="related_parent_sample" value="N2" /> | |
430 <param name="ifile" value="a.vcf" /> | |
431 </conditional> | |
432 </conditional> | |
433 <expand macro="test_tabular_out" /> | |
434 <output name="pfile" file="vaf_linkage.pdf" ftype="pdf" | |
435 compare="sim_size" delta="100000" /> | |
436 </test> | |
437 </tests> | |
438 | |
439 <help><![CDATA[ | |
440 .. class:: infomark | |
441 | |
442 **What it does** | |
443 | |
444 This is the most downstream tool in | |
445 `mapping-by-sequencing analysis workflows in MiModD`_. | |
446 | |
447 It can be used to analyze and visualize the inheritance pattern of variants | |
448 detected and selected with other MiModD tools or as an alternative (and more | |
449 versatile) plotting engine for data generated with `CloudMap`_. | |
450 | |
451 ------------- | |
452 | |
453 **Usage Modes:** | |
454 | |
455 This tool can be run in one of three different modes depending on the type of | |
456 mapping analysis that should be performed: | |
457 | |
458 1) *Simple Variant Density (SVD) Mapping* mode analyzes the density of variants | |
459 along the reference genome by dividing each chromosome into regions of | |
460 user-defined size (bins) and counting the variants found in each bin. | |
461 | |
462 All variants listed in the input file are analyzed in this mode, which means | |
463 that as input you will typically want to use filtered lists of variants (as | |
464 produced by the VCF Filter tool). | |
465 | |
466 The aim of SVD analysis is to identify clusters of variants in an outcrossed | |
467 strain carrying a selectable unknown mutation, which is interpreted as | |
468 linkage between the corresponding genomic region and the unknown mutation. | |
469 | |
470 This mode corresponds roughly to EMS Variant Density Mapping in CloudMap. | |
471 | |
472 2) *Variant Allele Frequency (VAF) Mapping* mode analyzes the inheritance | |
473 pattern in cross-progeny at sites, at which the parents are homozygous for | |
474 different alleles. | |
475 | |
476 The aim of VAF analysis is to identify clusters of variants with (near) | |
477 homozygous inheritance in a F2 (or later generation) population obtained | |
478 from a cross between a strain carrying a selectable unknown mutation and an | |
479 unrelated mapping strain. Such a cluster is interpreted as linkage between | |
480 the corresponding genomic region and the unknown mutation selected for in | |
481 the F2 generation. | |
482 | |
483 This mode corresponds roughly to Hawaiian Variant Mapping in CloudMap, but | |
484 can simultaneously take into account non-reference alleles found in either | |
485 parent strain (CloudMap users may think of this as a combined Hawaiian | |
486 Variant and Variant Discovery Mapping analysis). | |
487 | |
488 3) *Variant Allele Contrast (VAC) Mapping* mode analyzes and visualizes the | |
489 divergence between two samples at all sites in the input dataset. It works | |
490 independent of any parent strain information and can be used if you have two | |
491 samples selected for contrary phenotypes, but also with a selected and a | |
492 non-selected sample. | |
493 | |
494 ------------- | |
495 | |
496 **Input:** | |
497 | |
498 Valid input for this tool are VCF datasets (any such dataset in SVD mode, a | |
499 MiModD-generated multi-sample VCF dataset in VAF and VAC modes) or a tabular | |
500 report as generated by the CloudMap Hawaiian Variant Mapping tool. | |
501 Alternatively, the tool can generate (in both modes) its own tabular reports, | |
502 which can be used as input instead of the original VCF dataset, when rerunning | |
503 the tool with different plotting parameters, to reduce analysis time. | |
504 | |
505 ------------- | |
506 | |
507 **Output:** | |
508 | |
509 The tool produces up to three output files: | |
510 | |
511 1) a default tabular report of binned variant counts that can be used to plot | |
512 the data with external software such as Excel, | |
513 | |
514 2) an optional pdf containing linkage plots, and | |
515 | |
516 3) an optional tabular per-variant report, which can be configured to be either | |
517 valid input for the corresponding original CloudMap tool (for users who | |
518 really, really want to continue using CloudMap for plotting) or to be | |
519 reusable in fast reruns of the tool (which can be useful to experiment with | |
520 different plotting parameters). | |
521 | |
522 ------------- | |
523 | |
524 **Settings:** | |
525 | |
526 1) Analysis settings | |
527 | |
528 *bin size to analyze variants in* - determines the width of the regions | |
529 along each chromosome, in which variants are counted and analyzed together. | |
530 | |
531 Several bin sizes can be specified and for each size you will get a | |
532 corresponding results section in the binned variant counts report and a | |
533 linkage histogram plot. | |
534 | |
535 *sample names (in VAF and VAC modes only)* - to analyze inheritance | |
536 patterns, the VAF and VAC modes need information about the relationship | |
537 between the samples defined in the input. While VAC mode simply requires | |
538 you to name the two contrasting samples for the analysis, the sample roles | |
539 in VAF mode are a bit more complicated to understand. Specifically: | |
540 | |
541 The *mapping sample name* should be set to the name of the sample for which | |
542 the inheritance pattern is to be analyzed (the pooled progeny population). | |
543 | |
544 The *name of the related sample* should indicate the parent sample that | |
545 carried and brought in the unknown mutation to be mapped (or, alternatively, | |
546 a closely related ancestor). | |
547 | |
548 The *name of the unrelated sample* should be that of the other parent strain | |
549 used in the cross. | |
550 | |
551 At least one of the parent samples MUST be specified, but if the input | |
552 contains variant information for both parents, they can be analyzed together | |
553 for higher mapping accuracy. If you are reanalyzing a tabular report from a | |
554 previous tool run or from CloudMap, the association between variants and | |
555 samples is already stored in the input dataset and cannot be specified | |
556 again. | |
557 | |
558 2) Graphical output settings | |
559 | |
560 .. class:: warningmark | |
561 | |
562 To be able to generate plots, the system running MiModD needs to have the | |
563 statistical programming environment R and its Python interface rpy2 | |
564 installed. Disable graphical output if this is not the case. | |
565 | |
566 *y-axes scaling* - if you want to override the defaults | |
567 | |
568 *x-axis scaling* - choose *preserve relative contig sizes* if you want the | |
569 largest chromosome to fit the page width and smaller chromosomes to appear | |
570 according to their relative size or choose *scale each contig to fit the | |
571 plot width* if all chromosomes should exploit the available space | |
572 | |
573 *span value to be used in calculating the Loess regression line* - this | |
574 value determines the degree of smoothing of the regression line through the | |
575 scatterplot data. Information on loess regression and the loess span | |
576 parameter can be found at http://en.wikipedia.org/wiki/Local_regression. | |
577 | |
578 *colors used for plotting* - can be selected freely from the offered | |
579 palette. For histogram colors, the list of selected colors will be used to | |
580 provide the colors for the different histograms plotted. If less colors than | |
581 histograms (determined by the number of bin sizes selected) are specified, | |
582 colors from the list will be recycled. | |
583 | |
584 .. _CloudMap: https://usegalaxy.org/u/gm2123/p/cloudmap | |
585 .. _mapping-by-sequencing analysis workflows in MiModD: http://mimodd.readthedocs.io/en/latest/nacreousmap.html | |
586 .. _CloudMap-style sequence dictionary: http://mimodd.readthedocs.io/en/latest/fileformats.html#cloudmap-style-sequence-dictionary | |
587 | |
588 @HELP_FOOTER@ | |
589 ]]></help> | |
590 <expand macro="citations" /> | |
591 </tool> |