annotate cwpair2.xml @ 10:b52d6705aed0 draft

Uploaded
author greg
date Wed, 02 Dec 2015 16:14:07 -0500
parents d455f14530dc
children 6383cae47688
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
507521bf124a Uploaded
greg
parents:
diff changeset
1 <?xml version="1.0"?>
507521bf124a Uploaded
greg
parents:
diff changeset
2 <tool id="cwpair2" name="CWPair2" version="@WRAPPER_VERSION@.0">
507521bf124a Uploaded
greg
parents:
diff changeset
3 <description>find matched pairs and unmatched orphans</description>
507521bf124a Uploaded
greg
parents:
diff changeset
4 <macros>
507521bf124a Uploaded
greg
parents:
diff changeset
5 <import>cwpair2_macros.xml</import>
507521bf124a Uploaded
greg
parents:
diff changeset
6 </macros>
507521bf124a Uploaded
greg
parents:
diff changeset
7 <expand macro="requirements" />
507521bf124a Uploaded
greg
parents:
diff changeset
8 <command>
507521bf124a Uploaded
greg
parents:
diff changeset
9 <![CDATA[
507521bf124a Uploaded
greg
parents:
diff changeset
10 python $__tool_directory__/cwpair2.py
507521bf124a Uploaded
greg
parents:
diff changeset
11 #for $i in $input:
507521bf124a Uploaded
greg
parents:
diff changeset
12 --input "${i}" "${i.hid}"
507521bf124a Uploaded
greg
parents:
diff changeset
13 #end for
507521bf124a Uploaded
greg
parents:
diff changeset
14 --up_distance $up_distance
507521bf124a Uploaded
greg
parents:
diff changeset
15 --down_distance $down_distance
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
16 --method $method
0
507521bf124a Uploaded
greg
parents:
diff changeset
17 --binsize $binsize
507521bf124a Uploaded
greg
parents:
diff changeset
18 --threshold_format $threshold_format_cond.threshold_format
507521bf124a Uploaded
greg
parents:
diff changeset
19 #if str($threshold_format_cond.threshold_format) == "absolute_threshold":
507521bf124a Uploaded
greg
parents:
diff changeset
20 --absolute_threshold $threshold_format_cond.absolute_threshold
507521bf124a Uploaded
greg
parents:
diff changeset
21 #elif str($threshold_format_cond.threshold_format) == "relative_threshold":
507521bf124a Uploaded
greg
parents:
diff changeset
22 --relative_threshold $threshold_format_cond.relative_threshold
507521bf124a Uploaded
greg
parents:
diff changeset
23 #end if
4
9ed566138ecb Uploaded
greg
parents: 0
diff changeset
24 --output_files $output_files
0
507521bf124a Uploaded
greg
parents:
diff changeset
25 --statistics_output "$statistics_output"
507521bf124a Uploaded
greg
parents:
diff changeset
26 ]]>
507521bf124a Uploaded
greg
parents:
diff changeset
27 </command>
507521bf124a Uploaded
greg
parents:
diff changeset
28 <inputs>
507521bf124a Uploaded
greg
parents:
diff changeset
29 <param name="input" type="data" format="gff" multiple="True" label="Find matched pairs on" />
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
30 <param name="up_distance" type="integer" value="50" min="0" label="Distance upstream from a peak to allow a pair" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
31 <param name="down_distance" type="integer" value="100" min="0" label="Distance downstream from a peak to allow a pair" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
32 <param name="method" type="select" label="Method of finding a match">
507521bf124a Uploaded
greg
parents:
diff changeset
33 <option value="mode" selected="True">Mode</option>
507521bf124a Uploaded
greg
parents:
diff changeset
34 <option value="closest">Closest</option>
507521bf124a Uploaded
greg
parents:
diff changeset
35 <option value="largest">Largest</option>
507521bf124a Uploaded
greg
parents:
diff changeset
36 <option value="all">All</option>
507521bf124a Uploaded
greg
parents:
diff changeset
37 </param>
507521bf124a Uploaded
greg
parents:
diff changeset
38 <param name="binsize" type="integer" value="1" min="0" label="Width of bins for frequency plots and mode calculation" help="Value 1 implies no bins" />
507521bf124a Uploaded
greg
parents:
diff changeset
39 <conditional name="threshold_format_cond">
507521bf124a Uploaded
greg
parents:
diff changeset
40 <param name="threshold_format" type="select" label="Filter using">
507521bf124a Uploaded
greg
parents:
diff changeset
41 <option value="relative_threshold" selected="True">Relative threshold</option>
507521bf124a Uploaded
greg
parents:
diff changeset
42 <option value="absolute_threshold">Absolute threshold</option>
507521bf124a Uploaded
greg
parents:
diff changeset
43 </param>
507521bf124a Uploaded
greg
parents:
diff changeset
44 <when value="relative_threshold">
507521bf124a Uploaded
greg
parents:
diff changeset
45 <param name="relative_threshold" type="float" value="0.0" min="0.0" label="Percentage of the 95 percentile value to filter below" help="Value 0 results in no filtering" />
507521bf124a Uploaded
greg
parents:
diff changeset
46 </when>
507521bf124a Uploaded
greg
parents:
diff changeset
47 <when value="absolute_threshold">
507521bf124a Uploaded
greg
parents:
diff changeset
48 <param name="absolute_threshold" type="float" value="0.0" min="0.0" label="Absolute value to filter below" />
507521bf124a Uploaded
greg
parents:
diff changeset
49 </when>
507521bf124a Uploaded
greg
parents:
diff changeset
50 </conditional>
4
9ed566138ecb Uploaded
greg
parents: 0
diff changeset
51 <param name="output_files" type="select" label="Restrict output to" help="Statistics will always be generated." >
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
52 <option value="all" selected="True">no restrictions (output everything: C,D,F,O,P,MP)</option>
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
53 <option value="matched_pair">matched pairs only (MP)</option>
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
54 <option value="matched_pair_orphan">matched pairs and orphans only (O,MP)</option>
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
55 <option value="matched_pair_orphan_detail">matched pairs, orphans and details only (D,O,MP)</option>
0
507521bf124a Uploaded
greg
parents:
diff changeset
56 </param>
507521bf124a Uploaded
greg
parents:
diff changeset
57 </inputs>
507521bf124a Uploaded
greg
parents:
diff changeset
58 <outputs>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
59 <data name="statistics_output" format="tabular" label="Statistics Table: ${tool.name} on ${on_string}" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
60 <collection name="H" type="list" label="Statistics Histogram: ${tool.name} on ${on_string}">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
61 <filter>output_files == "all"</filter>
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
62 <discover_datasets pattern="(?P&lt;designation&gt;.*)" directory="H" ext="pdf" visible="false" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
63 </collection>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
64 <collection name="D" type="list" label="Data D: ${tool.name} on ${on_string}">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
65 <filter>output_files in ["all", "matched_pair_orphan_detail"]</filter>
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
66 <discover_datasets pattern="(?P&lt;designation&gt;.*)" directory="data_D" ext="tabular" visible="false" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
67 </collection>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
68 <collection name="O" type="list" label="Data O: ${tool.name} on ${on_string}">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
69 <filter>output_files in ["all", "matched_pair_orphan", "matched_pair_orphan_detail"]</filter>
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
70 <discover_datasets pattern="(?P&lt;designation&gt;.*)" directory="data_O" ext="tabular" visible="false" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
71 </collection>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
72 <collection name="MP" type="list" label="Data MP: ${tool.name} on ${on_string}">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
73 <discover_datasets pattern="(?P&lt;designation&gt;.*)" directory="data_MP" ext="gff" visible="false" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
74 </collection>
507521bf124a Uploaded
greg
parents:
diff changeset
75 </outputs>
507521bf124a Uploaded
greg
parents:
diff changeset
76 <tests>
507521bf124a Uploaded
greg
parents:
diff changeset
77 <test>
507521bf124a Uploaded
greg
parents:
diff changeset
78 <param name="input" value="cwpair2_input1.gff" />
507521bf124a Uploaded
greg
parents:
diff changeset
79 <param name="up_distance" value="25" />
507521bf124a Uploaded
greg
parents:
diff changeset
80 <param name="down_distance" value="100" />
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
81 <param name="method" value="all" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
82 <param name="binsize" value="1" />
507521bf124a Uploaded
greg
parents:
diff changeset
83 <param name="threshold_format" value="relative_threshold" />
507521bf124a Uploaded
greg
parents:
diff changeset
84 <param name="relative_threshold" value="0.0" />
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
85 <param name="output_files" value="matched_pair" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
86 <output name="statistics_output" file="statistics1.tabular" ftype="tabular" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
87 <output_collection name="MP" type="list">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
88 <element name="f0u25d100_on_data_1" file="closest_mp_output1.gff" ftype="gff" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
89 <element name="f0u25d100_on_data_1" file="largest_mp_output1.gff" ftype="gff" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
90 <element name="f0u25d100_on_data_1" file="mode_mp_output1.gff" ftype="gff" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
91 </output_collection>
507521bf124a Uploaded
greg
parents:
diff changeset
92 </test>
507521bf124a Uploaded
greg
parents:
diff changeset
93 <test>
507521bf124a Uploaded
greg
parents:
diff changeset
94 <param name="input" value="cwpair2_input1.gff" />
507521bf124a Uploaded
greg
parents:
diff changeset
95 <param name="up_distance" value="50" />
507521bf124a Uploaded
greg
parents:
diff changeset
96 <param name="down_distance" value="100" />
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
97 <param name="method" value="all" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
98 <param name="binsize" value="1" />
507521bf124a Uploaded
greg
parents:
diff changeset
99 <param name="threshold_format" value="relative_threshold" />
507521bf124a Uploaded
greg
parents:
diff changeset
100 <param name="relative_threshold" value="0.0" />
507521bf124a Uploaded
greg
parents:
diff changeset
101 <param name="output_files" value="all" />
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
102 <output name="statistics_output" file="statistics2.tabular" ftype="tabular" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
103 <output_collection name="H" type="list">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
104 <element name="histogram_C_mode_f0u50d100_on_data_1" file="mode_c_output2.pdf" ftype="pdf" compare="sim_size" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
105 <element name="histogram_F_closest_f0u50d100_on_data_1" file="closest_f_output2.pdf" ftype="pdf" compare="sim_size" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
106 <element name="histogram_F_largest_f0u50d100_on_data_1" file="largest_f_output2.pdf" ftype="pdf" compare="sim_size" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
107 <element name="histogram_F_mode_f0u50d100_on_data_1" file="mode_f_output2.pdf" ftype="pdf" compare="sim_size" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
108 <element name="histogram_P_mode_f0u50d100_on_data_1" file="mode_p_output2.pdf" ftype="pdf" compare="sim_size" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
109 </output_collection>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
110 <output_collection name="D" type="list">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
111 <element name="data_D_closest_f0u50d100_on_data_1" file="closest_d_output2.tabular" ftype="tabular" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
112 <element name="data_D_largest_f0u50d100_on_data_1" file="largest_d_output2.tabular" ftype="tabular" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
113 <element name="data_D_mode_f0u50d100_on_data_1" file="mode_d_output2.tabular" ftype="tabular" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
114 </output_collection>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
115 <output_collection name="O" type="list">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
116 <element name="data_O_closest_f0u50d100_on_data_1" file="closest_o_output2.tabular" ftype="tabular" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
117 <element name="data_O_largest_f0u50d100_on_data_1" file="largest_o_output2.tabular" ftype="tabular" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
118 <element name="data_O_mode_f0u50d100_on_data_1" file="mode_o_output2.tabular" ftype="tabular" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
119 </output_collection>
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
120 <output_collection name="MP" type="list">
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
121 <element name="data_MP_closest_f0u50d100_on_data_1" file="closest_mp_output2.gff" ftype="gff" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
122 <element name="data_MP_largest_f0u50d100_on_data_1" file="largest_mp_output2.gff" ftype="gff" />
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
123 <element name="data_MP_mode_f0u50d100_on_data_1" file="mode_mp_output2.gff" ftype="gff" />
0
507521bf124a Uploaded
greg
parents:
diff changeset
124 </output_collection>
507521bf124a Uploaded
greg
parents:
diff changeset
125 </test>
507521bf124a Uploaded
greg
parents:
diff changeset
126 </tests>
507521bf124a Uploaded
greg
parents:
diff changeset
127 <help>
507521bf124a Uploaded
greg
parents:
diff changeset
128 **What it does**
507521bf124a Uploaded
greg
parents:
diff changeset
129
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
130 Takes a list of called peaks on both strands and produces lists of matched pairs and unmatched peaks using a
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
131 specified method for finding matched pairs. Methods for finding matched pairs are mode, closest, largest or
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
132 all (where the analysis is run for each method). A statistics dataset is generated and a collection of datasets
0
507521bf124a Uploaded
greg
parents:
diff changeset
133 is produced for each method as follows.
507521bf124a Uploaded
greg
parents:
diff changeset
134
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
135 **Data Files**
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
136
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
137 * **closest/largest/mode MP** - the Matched Pairs in gff format
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
138 * **closest/largest/mode O** - the Orphans in tabular format
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
139 * **closest/largest/mode D** - the Details in tabular format
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
140
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
141 **Statistics Files**
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
142
4
9ed566138ecb Uploaded
greg
parents: 0
diff changeset
143 * **closest/largest/mode C** - the stastics graph in pdf format
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
144 * **closest/largest/mode P** - the preview plots graph in pdf format
4
9ed566138ecb Uploaded
greg
parents: 0
diff changeset
145 * **closest/largest/mode F** - the final plots graph in pdf format
0
507521bf124a Uploaded
greg
parents:
diff changeset
146
4
9ed566138ecb Uploaded
greg
parents: 0
diff changeset
147 -----
0
507521bf124a Uploaded
greg
parents:
diff changeset
148
507521bf124a Uploaded
greg
parents:
diff changeset
149 **Options**
507521bf124a Uploaded
greg
parents:
diff changeset
150
507521bf124a Uploaded
greg
parents:
diff changeset
151 * **Method of finding match** - Method of finding matched pair, mode, closest, largest, or all (run with each method).
507521bf124a Uploaded
greg
parents:
diff changeset
152 * **Distance upstream from a peak to allow a pair** - Distance upstream from a Watson peak to allow a Crick pair.
507521bf124a Uploaded
greg
parents:
diff changeset
153 * **Distance downstream from a peak to allow a pair** - Distance downstream from a Watson peak to allow a Crick pair.
507521bf124a Uploaded
greg
parents:
diff changeset
154 * **Percentage of the 95 percentile value to filter below** - Percentage of the 95 percentile value below which to filter when using a relative threshold.
507521bf124a Uploaded
greg
parents:
diff changeset
155 * **Absolute value to filter below** - Absolute value below which to filter when using an absolute threshold.
10
b52d6705aed0 Uploaded
greg
parents: 7
diff changeset
156 * **Output files** - Restrict output dataset collections to matched pairs only or one of several combinations of collection types.
0
507521bf124a Uploaded
greg
parents:
diff changeset
157
507521bf124a Uploaded
greg
parents:
diff changeset
158 </help>
507521bf124a Uploaded
greg
parents:
diff changeset
159 <expand macro="citations" />
507521bf124a Uploaded
greg
parents:
diff changeset
160 </tool>