annotate DimontWeb.xml @ 6:6bc47a4dca07 draft

Uploaded
author grau
date Wed, 06 Nov 2013 17:09:17 -0500
parents 23b912162e3b
children 85fd336b5b45
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
23b912162e3b Uploaded
grau
parents:
diff changeset
1 <tool id="Dimont" name="Dimont" version="0.1" force_history_refresh="true">
23b912162e3b Uploaded
grau
parents:
diff changeset
2 <description>Dimont, a universal tool for de-novo motif discovery (beta).</description>
23b912162e3b Uploaded
grau
parents:
diff changeset
3 <command>java -Xms256M -Xmx2G -jar \$JAR_PATH/DimontWeb.jar --run $script_file $summary $summary.id $__new_file_path__ $summary.extra_files_path</command>
23b912162e3b Uploaded
grau
parents:
diff changeset
4 <inputs>
23b912162e3b Uploaded
grau
parents:
diff changeset
5 <param type="text" size="40" name="Dimont_jobname" label="Job name" value="" optional="true" help="Please enter a name for your job that should be used in the history (optional)">
23b912162e3b Uploaded
grau
parents:
diff changeset
6 </param>
23b912162e3b Uploaded
grau
parents:
diff changeset
7 <param type="data" format="fasta" name="Dimont_ps_Input_sequences" label="&lt;hr /&gt;Input sequences" help="The input sequences for de-novo motif discovery (can be uploaded using &quot;GetData&quot; -&gt; &quot;Upload File&quot;), annotated FastA format. The required format is described in the help section." value="" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
8 </param>
23b912162e3b Uploaded
grau
parents:
diff changeset
9
23b912162e3b Uploaded
grau
parents:
diff changeset
10 <param type="text" size="40" name="Dimont_ps_Position_tag" label="Position tag" help="The tag for the position information in the FastA-annotation of the input file" value="" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
11 </param>
23b912162e3b Uploaded
grau
parents:
diff changeset
12
23b912162e3b Uploaded
grau
parents:
diff changeset
13 <param type="text" size="40" name="Dimont_ps_Value_tag" label="Value tag" help="The tag for the value information in the FastA-annotation of the input file" value="" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
14 </param>
23b912162e3b Uploaded
grau
parents:
diff changeset
15
23b912162e3b Uploaded
grau
parents:
diff changeset
16 <param type="float" name="Dimont_ps_Standard_deviation" label="Standard deviation" help="The standard deviation of the position distribution centered at the position specified by the position tag" value="75.0" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
17 <validator type="in_range" min="1.0" max="10000.0" message="Value is not in the specified range [1.0, 10000.0]."/></param>
23b912162e3b Uploaded
grau
parents:
diff changeset
18
23b912162e3b Uploaded
grau
parents:
diff changeset
19 <param type="text" size="40" name="Dimont_ps_Weighting_factor" label="Weighting factor" help="The value for weighting the data; either a value between 0 and 1, or a description relative to the standard deviation (e.g. +4sd)" value="0.2" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
20 </param>
23b912162e3b Uploaded
grau
parents:
diff changeset
21
23b912162e3b Uploaded
grau
parents:
diff changeset
22 <param type="integer" name="Dimont_ps_Starts" label="&lt;hr /&gt;Starts" help="The number of pre-optimization runs." value="20" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
23 <validator type="in_range" min="1" max="100" message="Value is not in the specified range [1, 100]."/></param>
23b912162e3b Uploaded
grau
parents:
diff changeset
24
23b912162e3b Uploaded
grau
parents:
diff changeset
25 <param type="integer" name="Dimont_ps_Initial_motif_width" label="&lt;hr /&gt;Initial motif width" help="The motif width that is used initially, may be adjusted during optimization." value="15" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
26 <validator type="in_range" min="1" max="50" message="Value is not in the specified range [1, 50]."/></param>
23b912162e3b Uploaded
grau
parents:
diff changeset
27
23b912162e3b Uploaded
grau
parents:
diff changeset
28 <param type="integer" name="Dimont_ps_Markov_order_of_motif_model" label="Markov order of motif model" help="The Markov order of the model for the motif." value="0" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
29 <validator type="in_range" min="0" max="3" message="Value is not in the specified range [0, 3]."/></param>
23b912162e3b Uploaded
grau
parents:
diff changeset
30
23b912162e3b Uploaded
grau
parents:
diff changeset
31 <param type="integer" name="Dimont_ps_Markov_order_of_background_model" label="Markov order of background model" help="The Markov order of the model for the background sequence and the background sequence, -1 defines uniform distribution." value="-1" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
32 <validator type="in_range" min="-1" max="5" message="Value is not in the specified range [-1, 5]."/></param>
23b912162e3b Uploaded
grau
parents:
diff changeset
33
23b912162e3b Uploaded
grau
parents:
diff changeset
34 <param type="float" name="Dimont_ps_Equivalent_sample_size" label="&lt;hr /&gt;Equivalent sample size" help="Reflects the strength of the prior on the model parameters." value="4.0" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
35 <validator type="in_range" min="0.0" max="Infinity" message="Value is not in the specified range [0.0, Infinity]."/></param>
23b912162e3b Uploaded
grau
parents:
diff changeset
36
23b912162e3b Uploaded
grau
parents:
diff changeset
37 <param type="boolean" name="Dimont_ps_Delete_BSs_from_profile" label="Delete BSs from profile" help="A switch for deleting binding site positions of discovered motifs from the profile before searching for futher motifs." checked="True" optional="false">
23b912162e3b Uploaded
grau
parents:
diff changeset
38 </param>
23b912162e3b Uploaded
grau
parents:
diff changeset
39
23b912162e3b Uploaded
grau
parents:
diff changeset
40 </inputs>
23b912162e3b Uploaded
grau
parents:
diff changeset
41 <requirements>
23b912162e3b Uploaded
grau
parents:
diff changeset
42 <requirement type="set_environment">JAR_PATH</requirement>
23b912162e3b Uploaded
grau
parents:
diff changeset
43 </requirements>
23b912162e3b Uploaded
grau
parents:
diff changeset
44 <configfiles>
23b912162e3b Uploaded
grau
parents:
diff changeset
45 <configfile name="script_file">
23b912162e3b Uploaded
grau
parents:
diff changeset
46 &lt;Dimont_ps_Input_sequences&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
47 &lt;value&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
48 ${Dimont_ps_Input_sequences}&lt;/value&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
49 &lt;extension&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
50 ${Dimont_ps_Input_sequences.ext}&lt;/extension&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
51 &lt;/Dimont_ps_Input_sequences&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
52
23b912162e3b Uploaded
grau
parents:
diff changeset
53 &lt;Dimont_ps_Position_tag&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
54 ${Dimont_ps_Position_tag}&lt;/Dimont_ps_Position_tag&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
55
23b912162e3b Uploaded
grau
parents:
diff changeset
56 &lt;Dimont_ps_Value_tag&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
57 ${Dimont_ps_Value_tag}&lt;/Dimont_ps_Value_tag&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
58
23b912162e3b Uploaded
grau
parents:
diff changeset
59 &lt;Dimont_ps_Standard_deviation&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
60 ${Dimont_ps_Standard_deviation}&lt;/Dimont_ps_Standard_deviation&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
61
23b912162e3b Uploaded
grau
parents:
diff changeset
62 &lt;Dimont_ps_Weighting_factor&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
63 ${Dimont_ps_Weighting_factor}&lt;/Dimont_ps_Weighting_factor&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
64
23b912162e3b Uploaded
grau
parents:
diff changeset
65 &lt;Dimont_ps_Starts&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
66 ${Dimont_ps_Starts}&lt;/Dimont_ps_Starts&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
67
23b912162e3b Uploaded
grau
parents:
diff changeset
68 &lt;Dimont_ps_Initial_motif_width&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
69 ${Dimont_ps_Initial_motif_width}&lt;/Dimont_ps_Initial_motif_width&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
70
23b912162e3b Uploaded
grau
parents:
diff changeset
71 &lt;Dimont_ps_Markov_order_of_motif_model&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
72 ${Dimont_ps_Markov_order_of_motif_model}&lt;/Dimont_ps_Markov_order_of_motif_model&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
73
23b912162e3b Uploaded
grau
parents:
diff changeset
74 &lt;Dimont_ps_Markov_order_of_background_model&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
75 ${Dimont_ps_Markov_order_of_background_model}&lt;/Dimont_ps_Markov_order_of_background_model&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
76
23b912162e3b Uploaded
grau
parents:
diff changeset
77 &lt;Dimont_ps_Equivalent_sample_size&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
78 ${Dimont_ps_Equivalent_sample_size}&lt;/Dimont_ps_Equivalent_sample_size&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
79
23b912162e3b Uploaded
grau
parents:
diff changeset
80 &lt;Dimont_ps_Delete_BSs_from_profile&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
81 ${Dimont_ps_Delete_BSs_from_profile}&lt;/Dimont_ps_Delete_BSs_from_profile&gt;
23b912162e3b Uploaded
grau
parents:
diff changeset
82
23b912162e3b Uploaded
grau
parents:
diff changeset
83 </configfile>
23b912162e3b Uploaded
grau
parents:
diff changeset
84 </configfiles>
23b912162e3b Uploaded
grau
parents:
diff changeset
85 <outputs>
23b912162e3b Uploaded
grau
parents:
diff changeset
86 <data format="html" name="summary" label="#if str($Dimont_jobname) == '' then $tool.name + ' on ' + $on_string else $Dimont_jobname#">
23b912162e3b Uploaded
grau
parents:
diff changeset
87 </data>
23b912162e3b Uploaded
grau
parents:
diff changeset
88 </outputs>
6
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
89 <tests>
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
90 <test>
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
91 <param name="Dimont_jobname" value="Test" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
92 <param name="Dimont_ps_Input_sequences" value="dimont_test.fasta" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
93 <param name="Dimont_ps_Position_tag" value="peakSummit" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
94 <param name="Dimont_ps_Value_tag" value="maxT" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
95 <param name="Dimont_ps_Standard_deviation" value="75.0" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
96 <param name="Dimont_ps_Weighting_factor" value="0.2" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
97 <param name="Dimont_ps_Starts" value="20" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
98 <param name="Dimont_ps_Initial_motif_width" value="15" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
99 <param name="Dimont_ps_Markov_order_of_motif_model" value="0" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
100 <param name="Dimont_ps_Markov_order_of_background_model" value="-1" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
101 <param name="Dimont_ps_Equivalent_sample_size" value="4.0" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
102 <param name="Dimont_ps_Delete_BSs_from_profile" value="True" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
103 <output name="summary" file="Test/Test_html.html" />
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
104 </test>
6bc47a4dca07 Uploaded
grau
parents: 4
diff changeset
105 </tests>
4
23b912162e3b Uploaded
grau
parents:
diff changeset
106 <help>
23b912162e3b Uploaded
grau
parents:
diff changeset
107 **Dimont** is a universal tool for de-novo motif discovery. Dimont has successfully been applied to ChIP-seq, ChIP-exo and protein-binding microarray (PBM) data.
23b912162e3b Uploaded
grau
parents:
diff changeset
108
23b912162e3b Uploaded
grau
parents:
diff changeset
109 Input sequences must be supplied in an annotated FastA format as a file uploaded by the "Upload File" task in section "Get Data" of Galaxy.
23b912162e3b Uploaded
grau
parents:
diff changeset
110 In the annotation of each sequence, you need to provide a value that reflects the confidence that this sequence is bound by the factor of interest.
23b912162e3b Uploaded
grau
parents:
diff changeset
111 Such confidences may be peak statistics (e.g., number of fragments under a peak) for ChIP data or signal intensities for PBM data. In addition, you need to provide an anchor position within the sequence.
23b912162e3b Uploaded
grau
parents:
diff changeset
112 In case of ChIP data, this anchor position could for instance be the peak summit.
23b912162e3b Uploaded
grau
parents:
diff changeset
113 For instance, an annotated FastA file for ChIP-exo data comprising sequences of length 100 centered around the peak summit could look like::
23b912162e3b Uploaded
grau
parents:
diff changeset
114
23b912162e3b Uploaded
grau
parents:
diff changeset
115 > peak: 50; signal: 515
23b912162e3b Uploaded
grau
parents:
diff changeset
116 ggccatgtgtatttttttaaatttccac...
23b912162e3b Uploaded
grau
parents:
diff changeset
117 > peak: 50; signal: 199
23b912162e3b Uploaded
grau
parents:
diff changeset
118 GGTCCCCTGGGAGGATGGGGACGTGCTG...
23b912162e3b Uploaded
grau
parents:
diff changeset
119 ...
23b912162e3b Uploaded
grau
parents:
diff changeset
120
23b912162e3b Uploaded
grau
parents:
diff changeset
121 where the anchor point is given as 50 for the first two sequences, and the confidence amounts to 515 and 199, respectively.
23b912162e3b Uploaded
grau
parents:
diff changeset
122 The FastA comment may contain additional annotations of the format ``key1 : value1; key2: value2;...``.
23b912162e3b Uploaded
grau
parents:
diff changeset
123 We also provide an example_ input file and a Perl script_ for preparing data in the format required by Dimont.
23b912162e3b Uploaded
grau
parents:
diff changeset
124
23b912162e3b Uploaded
grau
parents:
diff changeset
125 Accordingly, you would need to set the parameter "Position tag" to ``peak`` and the parameter "Value tag" to ``signal`` for the input file.
23b912162e3b Uploaded
grau
parents:
diff changeset
126
23b912162e3b Uploaded
grau
parents:
diff changeset
127 For the standard deviation of the position prior, the initial motif length and the number of pre-optimization runs, we provide default values that worked well in our studies on ChIP and PBM data.
23b912162e3b Uploaded
grau
parents:
diff changeset
128 However, you may want adjust these parameters to meet your prior information.
23b912162e3b Uploaded
grau
parents:
diff changeset
129
23b912162e3b Uploaded
grau
parents:
diff changeset
130 The parameter "Markov order of the motif model" sets the order of the inhomogeneous Markov model used for modeling the motif. If this parameter is set to ``0``, you obtain a position weight matrix (PWM) model.
23b912162e3b Uploaded
grau
parents:
diff changeset
131 If it is set to ``1``, you obtain a weight array matrix (WAM) model. You can set the order of the motif model to at most ``3``.
23b912162e3b Uploaded
grau
parents:
diff changeset
132
23b912162e3b Uploaded
grau
parents:
diff changeset
133 The parameter "Markov order of the background model" sets the order of the homogeneous Markov model used for modeling positions not covered by a motif.
23b912162e3b Uploaded
grau
parents:
diff changeset
134 If this parameter is set to ``-1``, you obtain a uniform distribution, which worked well for ChIP data. For PBM data, orders of up to ``4`` resulted in an increased prediction performance in our case studies. The maximum allowed value is ``5``.
23b912162e3b Uploaded
grau
parents:
diff changeset
135
23b912162e3b Uploaded
grau
parents:
diff changeset
136 The parameter "Weighting factor" defines the proportion of sequences that you expect to be bound by the targeted factor with high confidence. For ChIP data, the default value of ``0.2`` typically works well.
23b912162e3b Uploaded
grau
parents:
diff changeset
137 For PBM data, containing a large number of unspecific probes, this parameter should be set to a lower value, e.g. ``0.01``.
23b912162e3b Uploaded
grau
parents:
diff changeset
138
23b912162e3b Uploaded
grau
parents:
diff changeset
139 The "Equivalent sample size" reflects the strength of the influence of the prior on the model parameters, where higher values smooth out the parameters to a greater extent.
23b912162e3b Uploaded
grau
parents:
diff changeset
140
23b912162e3b Uploaded
grau
parents:
diff changeset
141 The parameter "Delete BSs from profile" defines if BSs of already discovered motifs should be deleted, i.e., "blanked out", from the sequence before searching for futher motifs.
23b912162e3b Uploaded
grau
parents:
diff changeset
142
23b912162e3b Uploaded
grau
parents:
diff changeset
143 You can also install this web-application within your local Galaxy server. Instructions can be found at the Dimont_ page of Jstacs.
23b912162e3b Uploaded
grau
parents:
diff changeset
144 There you can also download a command line version of Dimont.
23b912162e3b Uploaded
grau
parents:
diff changeset
145
23b912162e3b Uploaded
grau
parents:
diff changeset
146 If you experience problems using Dimont, please contact_ us.
23b912162e3b Uploaded
grau
parents:
diff changeset
147
23b912162e3b Uploaded
grau
parents:
diff changeset
148 .. _example: http://www.jstacs.de/downloads/dimont-example.fa
23b912162e3b Uploaded
grau
parents:
diff changeset
149 .. _script: http://www.jstacs.de/index.php/Dimont#Data_preparation
23b912162e3b Uploaded
grau
parents:
diff changeset
150 .. _Dimont: http://jstacs.de/index.php/Dimont
23b912162e3b Uploaded
grau
parents:
diff changeset
151 .. _contact: mailto:grau@informatik.uni-halle.de
23b912162e3b Uploaded
grau
parents:
diff changeset
152 </help>
23b912162e3b Uploaded
grau
parents:
diff changeset
153 </tool>
23b912162e3b Uploaded
grau
parents:
diff changeset
154