annotate cloudmap.xml @ 13:f0b3871cb869 draft

Uploaded
author wolma
date Mon, 25 Apr 2016 17:27:25 -0400
parents 93db2f9bca12
children aba6d9b1c1f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
9
93db2f9bca12 upgrade to v0.1.7.2
Wolfgang Maier wolfgang.maier@biologie.uni-freiburg.de
parents: 8
diff changeset
1 <tool id="nacreousmap" name="NacreousMap" version="0.1.7.2">
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
2 <description>Map causative mutations by multi-variant linkage analysis.</description>
2
72d20758ba2c final upload
wolma
parents: 1
diff changeset
3 <expand macro="requirements"/>
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
4 <version_command>mimodd version -q</version_command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
5 <command>
7
3619e85a5477 v0.1.7.0 bug fixes
Wolfgang Maier
parents: 6
diff changeset
6 mimodd map ${opt.mode} "${opt.source.ifile}"
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
7 #if $str($opt.source.sample):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
8 -m "${opt.source.sample}"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
9 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
10 #if $str($opt.source.related_parent_sample):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
11 -r "${opt.source.related_parent_sample}"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
12 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
13 #if $str($opt.source.unrelated_parent_sample):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
14 -u "${opt.source.unrelated_parent_sample}"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
15 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
16 $opt.source.infer_missing
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
17 -o "$ofile"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
18 #if $str($opt.source.seqdict_required.required) == "yes":
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
19 -s "${opt.source.seqdict_required.seqdict}"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
20 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
21 $opt.source.norm
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
22 #if $len($opt.source.bin_sizes):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
23 --bin-sizes
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
24 #for $size in $opt.source.bin_sizes:
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
25 "${size.bin_size}"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
26 #end for
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
27 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
28 #if $str($opt.source.tabfile):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
29 $str($opt.source.tabfile) $tfile
4
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
30 #end if
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
31 #if $str($opt.source.plotopts.plots):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
32 $str($opt.source.plotopts.plots) "$pfile"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
33 $str($opt.source.plotopts.xlim)
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
34 #if $str($opt.source.plotopts.hylim):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
35 --ylim-hist $str($opt.source.plotopts.hylim)
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
36 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
37 #if $str($opt.source.plotopts.hcols) and $len($opt.source.plotopts.hcols):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
38 --hist-colors
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
39 #for $color in $opt.source.plotopts.hcols:
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
40 "${color.hcolor}"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
41 #end for
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
42 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
43 #if $str($opt.source.plotopts.sylim):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
44 --ylim-scatter $str($opt.source.plotopts.sylim)
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
45 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
46 #if $str($opt.source.plotopts.pcol):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
47 --points-color "$str($opt.source.plotopts.pcol)"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
48 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
49 #if $str($opt.source.plotopts.lcol):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
50 --loess-color "$str($opt.source.plotopts.lcol)"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
51 #end if
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
52 #if $str($opt.source.plotopts.span):
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
53 --loess-span "$str($opt.source.plotopts.span)"
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
54 #end if
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
55 #end if
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
56
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
57 </command>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
58
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
59 <macros>
7
3619e85a5477 v0.1.7.0 bug fixes
Wolfgang Maier
parents: 6
diff changeset
60 <import>toolshed_macros.xml</import>
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
61 <macro name="svd_unconditional">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
62 <expand macro="hidden_vaf_algo_params" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
63 <expand macro="seqdict_param" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
64 <expand macro="bins" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
65 <param name="norm" type="boolean" label="normalize variant counts to bin-width" truevalue="" falsevalue="--no-normalize" checked="true" help="without normalization the tool will just report the number of nucleotides per bin; with normalization the results for different bin-widths will be comparable." />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
66 <conditional name="plotopts">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
67 <param name="plots" type="select" label="graphical output settings">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
68 <option value="">Do not generate graphs.</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
69 <option value="-p">Give me graphics.</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
70 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
71 <when value="-p">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
72 <expand macro="scatter_default" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
73 <param name="hylim" type="text" label="upper limit for the histogram y-axis (leave blank for automatic scaling)" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
74 <param name="xlim" type="select" label="x-axis scaling">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
75 <option value="">preserve relative contig sizes</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
76 <option value="--fit-width">scale each contig to fit the plot width</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
77 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
78 <expand macro="hist_colors" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
79 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
80 </conditional>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
81 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
82 <macro name="vaf_unconditional">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
83 <expand macro="bins" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
84 <param name="norm" type="boolean" label="normalize variant counts to bin-width" truevalue="" falsevalue="--no-normalize" checked="true" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
85 <conditional name="plotopts">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
86 <param name="plots" type="select" label="graphical output settings">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
87 <option value="">Do not generate graphs.</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
88 <option value="--no-scatter -p">Generate only histograms</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
89 <option value="--no-hist -p">Generate only scatter plots</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
90 <option value="-p">Give me everything (scatter plots and histograms)</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
91 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
92 <when value="--no-scatter -p">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
93 <expand macro="scatter_default" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
94 <param name="hylim" type="text" label="upper limit for the histogram y-axis (leave blank for automatic scaling)" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
95 <param name="xlim" type="select" label="x-axis scaling">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
96 <option value="">preserve relative contig sizes</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
97 <option value="--fit-width">scale each contig to fit the plot width</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
98 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
99 <expand macro="hist_colors" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
100 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
101 <when value="--no-hist -p">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
102 <expand macro="hist_default" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
103 <param name="sylim" type="text" label="upper limit for the scatter plot y-axis (default: 1)" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
104 <param name="xlim" type="select" label="x-axis scaling">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
105 <option value="">preserve relative contig sizes</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
106 <option value="--fit-width">scale each contig to fit the plot width</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
107 </param>
8
d79fe626c6fd upgrade to v0.1.7.1
Wolfgang Maier
parents: 7
diff changeset
108 <param name="span" type="text" label="span value to be used in calculating the Loess regression line through the scatter data (default=0.1, specify 0 to prevent calculation)" 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)." />
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
109 <expand macro="scatter_colors" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
110 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
111 <when value="-p">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
112 <expand macro="plot_all" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
113 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
114 </conditional>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
115 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
116 <macro name="hidden_vaf_algo_params">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
117 <param name="sample" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
118 <param name="related_parent_sample" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
119 <param name="unrelated_parent_sample" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
120 <param name="infer_missing" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
121 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
122 <macro name="bins">
7
3619e85a5477 v0.1.7.0 bug fixes
Wolfgang Maier
parents: 6
diff changeset
123 <repeat name="bin_sizes" title="bin sizes to analyze variants in (defaults to: 1Mb and 500Kb)" default="0" min="0" 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.">
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
124 <param name="bin_size" type="text" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
125 </repeat>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
126 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
127 <macro name="scatter_default">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
128 <param name="sylim" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
129 <param name="span" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
130 <param name="pcol" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
131 <param name="lcol" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
132 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
133 <macro name="hist_default">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
134 <param name="hylim" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
135 <param name="hcols" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
136 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
137 <macro name="hist_colors">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
138 <repeat name="hcols" title="histogram colors" default="0" min="0" 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).">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
139 <param name="hcolor" type="color" value="darkgrey">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
140 <sanitizer><valid><add value="#" /></valid></sanitizer>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
141 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
142 </repeat>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
143 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
144 <macro name="scatter_colors">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
145 <param name="pcol" type="color" value="#454545" label="color to be used for the scatter plot data points (default: gray27)">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
146 <sanitizer><valid><add value="#" /></valid></sanitizer>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
147 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
148 <param name="lcol" type="color" value="red" label="color to be used for the regression line (default: red)">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
149 <sanitizer><valid><add value="#" /></valid></sanitizer>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
150 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
151 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
152 <macro name="plot_all">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
153 <param name="hylim" type="text" label="upper limit for the histogram y-axis (leave blank for automatic scaling)" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
154 <param name="sylim" type="text" label="upper limit for the scatter plot y-axis (default: 1)" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
155 <param name="xlim" type="select" label="x-axis scaling">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
156 <option value="">preserve relative contig sizes</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
157 <option value="--fit-width">scale each contig to fit the plot width</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
158 </param>
8
d79fe626c6fd upgrade to v0.1.7.1
Wolfgang Maier
parents: 7
diff changeset
159 <param name="span" type="text" label="span value to be used in calculating the Loess regression line through the scatter data (default=0.1, specify 0 to prevent calculation)" 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)." />
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
160 <expand macro="hist_colors" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
161 <expand macro="scatter_colors" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
162 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
163 <macro name="seqdict_param">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
164 <conditional name="seqdict_required">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
165 <param name="required" type="select" label="does this input file require a CloudMap-style sequence dictionary?" help="A sequence dictionary file is required ONLY if the input file does not provide information about the sizes of the chromosomes defined in it. It is NEVER needed for MiModD-generated input files.">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
166 <option value="no">No</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
167 <option value="yes">Yes</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
168 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
169 <when value="yes">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
170 <param name="seqdict" type="data" format="tabular" label="CloudMap-style sequence dictionary file" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
171 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
172 </conditional>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
173 </macro>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
174 </macros>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
175
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
176 <inputs>
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
177 <conditional name="opt">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
178 <param name="mode" type="select" label="type of mapping analysis to perform" 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.">
4
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
179 <option value="SVD">Simple Variant Density Mapping</option>
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
180 <option value="VAF">Variant Allele Frequency Mapping</option>
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
181 </param>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
182 <when value="SVD">
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
183 <conditional name="source">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
184 <param name="inputtype" type="select" label="data source to use">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
185 <option value="vcf">VCF file of variants (for de-novo mapping)</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
186 <option value="rep">per-variant report file (for remapping a previous analysis)</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
187 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
188 <when value="vcf">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
189 <param name="ifile" type="data" format="vcf" label="input file with variants to analyze" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
190 <expand macro="svd_unconditional" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
191 <param name="tabfile" type="select" label="additional per-variant output file" 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 file that can be used as input for the CloudMap EMS Variant Density Mapping tool as an alternative plotting tool.">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
192 <option value="">Do not generate per-variant output</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
193 <option value="-t">Tabular per-variant report</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
194 <option value="--cloudmap -t">CloudMap compatibility file</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
195 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
196 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
197 <when value="rep">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
198 <param name="ifile" type="data" format="tabular" label="input file with variants to analyze" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
199 <param name="tabfile" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
200 <expand macro="svd_unconditional" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
201 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
202 </conditional>
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
203 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
204 <when value="VAF">
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
205 <conditional name="source">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
206 <param name="inputtype" type="select" label="data source to use">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
207 <option value="vcf">VCF file of variants (for de-novo mapping)</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
208 <option value="rep">per-variant report file (for remapping a previous analysis)</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
209 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
210 <when value="vcf">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
211 <param name="ifile" type="data" format="vcf" label="input file with variants to analyze" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
212 <expand macro="seqdict_param" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
213 <param name="sample" type="text" label="mapping sample name" help="the sample to perform mutation mapping for" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
214 <param name="related_parent_sample" type="text" label="name of the related parent sample" 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" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
215 <param name="unrelated_parent_sample" type="text" label="name of the unrelated parent sample" 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" />
8
d79fe626c6fd upgrade to v0.1.7.1
Wolfgang Maier
parents: 7
diff changeset
216 <param name="infer_missing" type="boolean" checked="false" truevalue="--infer-missing" falsevalue="" label="Infer alleles for missing parent" 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!" />
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
217 <expand macro="vaf_unconditional" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
218 <param name="tabfile" type="select" label="additional per-variant output file" 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 file that can be used as input for the CloudMap Hawaiian Variant Mapping tool as an alternative plotting tool.">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
219 <option value="">Do not generate per-variant output</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
220 <option value="-t">Tabular per-variant report</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
221 <option value="--cloudmap -t">CloudMap compatibility file</option>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
222 </param>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
223 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
224 <when value="rep">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
225 <param name="ifile" type="data" format="tabular" label="input file with variants to analyze" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
226 <expand macro="seqdict_param" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
227 <param name="tabfile" type="hidden" value="" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
228 <expand macro="hidden_vaf_algo_params" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
229 <expand macro="vaf_unconditional" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
230 </when>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
231 </conditional>
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
232 </when>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
233 </conditional>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
234 </inputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
235
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
236 <outputs>
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
237 <data name="ofile" format="tabular" label="MiModD ${opt.mode} Mapping - binned variant counts for ${on_string}" />
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
238 <data name="tfile" format="tabular" label="MiModD ${opt.mode} Mapping - per-variant report for ${on_string}">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
239 <filter>(opt['source']['tabfile'])</filter>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
240 </data>
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
241 <data name="pfile" format="pdf" label="MiModD ${opt.mode} Mapping - linkage plots for ${on_string}">
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
242 <filter>(opt['source']['plotopts']['plots'])</filter>
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
243 </data>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
244 </outputs>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
245
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
246 <help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
247 .. class:: infomark
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
248
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
249 **What it does**
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
250
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
251 This tool is a complete rewrite of and improves the EMS Variant Density and Hawaiian Variant Mapping tools of `CloudMap`_. It is the most downstream tool in `mapping-by-sequencing analysis workflows in MiModD`_.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
252
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
253 It can be used to analyze and visualize the inheritance pattern of variants detected and selected by other MiModD tools or as an alternative (and more versatile) plotting engine for data generated with `CloudMap`_.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
254
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
255 -------------
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
256
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
257 **Usage Modes:**
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
258
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
259 This tool can be run in one of two different modes depending on the type of mapping analysis that should be performed:
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
260
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
261 1) *Simple Variant Density (SVD) Mapping* mode analyzes the density of variants along the reference genome by dividing each chromosome into regions of user-defined size (bins) and counting the variants found in each bin.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
262
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
263 All variants listed in the input file are analyzed in this mode, which means that as input you will typically want to use filtered lists of variants (as produced by the VCF Filter tool).
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
264
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
265 The aim of SVD analysis is to identify clusters of variants in an outcrossed strain carrying a selectable unknown mutation, which is interpreted as linkage between the corresponding genomic region and the unknown mutation.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
266
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
267 This mode corresponds roughly to EMS Variant Density Mapping in CloudMap.
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
268
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
269 2) *Variant Allele Frequency (VAF) Mapping** mode analyzes the inheritance pattern in cross-progeny at sites, at which the parents are homozygous for different alleles.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
270
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
271 The aim of VAF analysis is to identify clusters of variants with (near) homozygous inheritance in a F2 (or later generation) population obtained from a cross between a strain carrying a selectable unknown mutation and an unrelated mapping strain. Such a cluster is interpreted as linkage between the corresponding genomic region and the unknown mutation selected for in the F2 generation.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
272
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
273 This mode corresponds roughly to Hawaiian Variant Mapping in CloudMap, but can simultaneously take into account non-reference alleles found in either parent strain (CloudMap users may think of this as a combined Hawaiian Variant and Variant Discovery Mapping analysis).
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
274
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
275 -------------
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
276
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
277 **Input:**
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
278
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
279 Valid input for this tool are VCF files (any VCF file in SVD mode, a MiModD-generated multi-sample VCF file in VAF mode) or a CloudMap tabular report file as generated by the Hawaiian Variant Mapping tool. Alternatively, the tool can generate (in both modes) its own tabular report file, which can be used as input instead of the original VCF file when rerunning the tool with different plotting parameters to reduce analysis time.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
280
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
281 .. class:: infomark
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
282
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
283 CloudMap-generated tabular input files require, as additional input, a CloudMap-style sequence dictionary (even if the original CloudMap analysis was possible without one) as described in the original CloudMap paper. This file has a simple two-column tab-delimited format, in which each line lists the chromosome name (as it appears in the input VCF file) and the up-rounded length of the chromosome in megabases.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
284
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
285 -------------
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
286
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
287 **Output:**
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
288
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
289 The tool produces up to three output files:
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
290
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
291 1) a default tabular file of binned variant counts that can be used to plot the data with external software such as Excel,
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
292
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
293
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
294 2) an optional pdf containing linkage plots, which should look just like the plots produced by CloudMap, but are optimized for file size and display speed and offer more user-configurable parameters and
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
295
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
296
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
297 3) an optional tabular per-variant report file, which can be configured to be either a valid input file for the corresponding original CloudMap tool (for users who really, really want to continue using CloudMap for plotting) or to be reusable in fast reruns of the tool (which can be useful to experiment with different plotting parameters).
4
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
298
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
299 -------------
4
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
300
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
301 **Settings:**
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
302
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
303 1) Analysis settings
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
304
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
305 *bin size to analyze variants in* - determines the width of the regions along each chromosome, in which variants are counted and analyzed together.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
306
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
307 Several bin sizes can be specified and for each size you will get a corresponding report section in the binned variant counts file and a histogram plot in the linkage plots file.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
308
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
309 *normalize variant counts to bin-width* - if selected (as per default) the variant counts for different bin sizes are not absolute, but normalized to the bin width
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
310
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
311 *sample names (in VAF mode only)* - to analyze inheritance patterns, VAF mode needs information about the relationship between the samples defined in the input VCF file:
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
312
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
313 The *mapping sample name* should be set to the name of the sample for which the inheritance pattern is to be analyzed (the pooled progeny population).
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
314
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
315 The *name of the related sample* should be that of the parent sample that carried and brought in the unknown mutation to be mapped (or, alternatively, that of a closely related ancestor).
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
316
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
317 Finally, the *name of the unrelated sample* should be that of the other parent strain used in the cross.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
318
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
319 At least one of the parent samples MUST be specified, but if the input file contains variant information for both parents, they can be analyzed together for higher mapping accuracy. If you are reanalyzing a tabular report file from a previous tool run or from CloudMap, the association between variants and samples is already incorporated into the input file and cannot be specified again.
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
320
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
321 2) Graphical output settings
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
322
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
323 .. class:: warningmark
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
324
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
325 To be able to generate plots the system running MiModD needs to have the statistical programming environment R and its Python interface rpy2 installed.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
326
4
ffee8534a5c4 upgrade to mimodd version 0.1.6
Wolfgang Maier
parents: 2
diff changeset
327
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
328 *y-axes scaling* - if you want to override the defaults
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
329
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
330 *x-axis scaling* - choose *preserve relative contig sizes* if you want the largest chromosome to fit the page width and smaller chromosomes to appear according to their relative size or choose *scale each contig to fit the plot width* if all chromosomes should exploit the available space
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
331
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
332 *span value to be used in calculating the Loess regression line* - this value determines the degree of smoothing of the regression line through the scatterplot data. Information on loess regression and the loess span parameter can be found at http://en.wikipedia.org/wiki/Local_regression. The default is 0.1 as in CloudMap.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
333
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
334 *colors used for plotting* - can be selected freely from the offered palette. For histogram colors, the list of selected colors will be used to provide the colors for the different histograms plotted. If less colors than histograms (determined by the number of bin sizes selected) are specified, colors from the list will be recycled.
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
335
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
336
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
337 .. _CloudMap: https://usegalaxy.org/u/gm2123/p/cloudmap
6
85214e4428fd upgrade to mimodd version 0.1.7.0
Wolfgang Maier
parents: 5
diff changeset
338 .. _mapping-by-sequencing analysis workflows in MiModD: http://mimodd.readthedocs.org/en/latest/cloudmap.html
0
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
339 </help>
6231ae8f87b8 Uploaded
wolma
parents:
diff changeset
340 </tool>