annotate DimontPredictorWeb.xml @ 1:eb36f7f72fb1 draft

Uploaded
author grau
date Wed, 20 Nov 2013 04:33:20 -0500
parents b7d6db3ba6bc
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
1 <tool id="DimontPredictor" name="DimontPredictor" version="0.1" force_history_refresh="true">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
2 <description>for predicting binding sites using a Dimont model</description>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
3 <command>java -Xms256M -Xmx2G -jar \$JAR_PATH/DimontPredictorWeb.jar --run $script_file $summary $summary.id $__new_file_path__ $summary.extra_files_path</command>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
4 <inputs>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
5 <param type="text" size="40" name="DimontPredictor_jobname" label="Job name" value="" optional="true" help="Please enter a name for your job that should be used in the history (optional)">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
6 </param>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
7 <param type="data" format="xml" name="DimontPredictor_ps_Dimont" label="&lt;hr /&gt;Dimont" help="The trained Dimont classifier, i.e. the &quot;Dimont&quot; output of a previous Dimont run." value="" optional="false">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
8 </param>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
9
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
10 <param type="data" format="fasta" name="DimontPredictor_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">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
11 </param>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
12
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
13 <param type="text" size="40" name="DimontPredictor_ps_Value_tag" label="Value tag" help="The tag for the value information in the FastA-annotation of the input file" value="" optional="false">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
14 </param>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
15
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
16 <param type="text" size="40" name="DimontPredictor_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">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
17 </param>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
18
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
19 <param type="float" name="DimontPredictor_ps_p_value" label="&lt;hr /&gt;p-value" help="The maximum p-value allowed for predicted binding sites" value="0.0010" optional="false">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
20 <validator type="in_range" min="0.0" max="1.0" message="Value is not in the specified range [0.0, 1.0]."/></param>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
21
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
22 </inputs>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
23 <requirements>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
24 <requirement type="set_environment">JAR_PATH</requirement>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
25 <requirement type="binary" version=">=1.6">java</requirement>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
26 </requirements>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
27 <configfiles>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
28 <configfile name="script_file">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
29 &lt;DimontPredictor_ps_Dimont&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
30 &lt;value&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
31 ${DimontPredictor_ps_Dimont}&lt;/value&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
32 &lt;extension&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
33 ${DimontPredictor_ps_Dimont.ext}&lt;/extension&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
34 &lt;/DimontPredictor_ps_Dimont&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
35
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
36 &lt;DimontPredictor_ps_Input_sequences&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
37 &lt;value&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
38 ${DimontPredictor_ps_Input_sequences}&lt;/value&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
39 &lt;extension&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
40 ${DimontPredictor_ps_Input_sequences.ext}&lt;/extension&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
41 &lt;/DimontPredictor_ps_Input_sequences&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
42
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
43 &lt;DimontPredictor_ps_Value_tag&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
44 ${DimontPredictor_ps_Value_tag}&lt;/DimontPredictor_ps_Value_tag&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
45
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
46 &lt;DimontPredictor_ps_Weighting_factor&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
47 ${DimontPredictor_ps_Weighting_factor}&lt;/DimontPredictor_ps_Weighting_factor&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
48
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
49 &lt;DimontPredictor_ps_p_value&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
50 ${DimontPredictor_ps_p_value}&lt;/DimontPredictor_ps_p_value&gt;
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
51
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
52 </configfile>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
53 </configfiles>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
54 <outputs>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
55 <data format="html" name="summary" label="#if str($DimontPredictor_jobname) == '' then $tool.name + ' on ' + $on_string else $DimontPredictor_jobname#">
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
56 </data>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
57 </outputs>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
58 <tests>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
59 <test>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
60 <param name="DimontPredictor_jobname" value="Test" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
61 <param name="DimontPredictor_ps_Dimont" value="predictor_test.xml" ftype="xml" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
62 <param name="DimontPredictor_ps_Input_sequences" value="dimont_test.fasta" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
63 <param name="DimontPredictor_ps_Value_tag" label="Value tag" value="maxT" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
64 <param name="DimontPredictor_ps_Weighting_factor" value="0.2" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
65 <param name="DimontPredictor_ps_p_value" value="0.0010" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
66 <output name="summary" file="TestPred/TestPred_html.html" />
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
67 </test>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
68 </tests>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
69 <help>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
70 **DimontPredictor** allows for predicting binding sites in new data using a previously trained Dimont model. For training a Dimont model see tool "Dimont".
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
71
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
72 This tool may be useful if you, for instance, want to predict binding sites of a previously discovered motifs in other data sets, or if you want to try different p-values for filtering predictions.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
73
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
74 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 or generated using the "Dimont Data Extractor" tool.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
75 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.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
76 Such confidences may be peak statistics (e.g., number of fragments under a peak) for ChIP data or signal intensities for PBM data.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
77
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
78 For instance, an annotated FastA file for ChIP-exo data could look like::
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
79
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
80 > signal: 515
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
81 ggccatgtgtatttttttaaatttccac...
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
82 > signal: 199
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
83 GGTCCCCTGGGAGGATGGGGACGTGCTG...
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
84 ...
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
85
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
86 where the confidence for the first two sequences amounts to 515 and 199, respectively.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
87 The FastA comment may contain additional annotations of the format ``key1 : value1; key2: value2;...``.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
88 We also provide an example_ input file.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
89
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
90 Accordingly, you would need to set the parameter "Value tag" to ``signal`` for this input file.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
91
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
92 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.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
93 For PBM data, containing a large number of unspecific probes, this parameter should be set to a lower value, e.g. ``0.01``.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
94
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
95 The parameter "p-value" defines a threshold on the p-values of predicted binding sites, and only binding sites with a lower p-value are reported by DimontPredictor.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
96 The Dimont tool uses a p-value threshold of ``1E-3``, which is also the default value of DimontPredictor.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
97
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
98 You can also install this web-application within your local Galaxy server. Instructions can be found at the Dimont_ page of Jstacs.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
99 There you can also download a command line version of DimontPredictor.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
100
1
eb36f7f72fb1 Uploaded
grau
parents: 0
diff changeset
101 If you use Dimont, please cite
eb36f7f72fb1 Uploaded
grau
parents: 0
diff changeset
102
eb36f7f72fb1 Uploaded
grau
parents: 0
diff changeset
103 \J. Grau, S. Posch, I. Grosse, and J. Keilwagen. A general approach for discriminative de-novo motif discovery from high-throughput data. *Nucleic Acids Research*, 41(21):e197, 2013.
eb36f7f72fb1 Uploaded
grau
parents: 0
diff changeset
104
0
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
105 If you experience problems using DimontPredictor, please contact_ us.
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
106
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
107 .. _example: http://www.jstacs.de/downloads/dimont-example.fa
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
108 .. _Dimont: http://jstacs.de/index.php/Dimont
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
109 .. _contact: mailto:grau@informatik.uni-halle.de
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
110 </help>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
111 </tool>
b7d6db3ba6bc Uploaded
grau
parents:
diff changeset
112