annotate repmatch_gff3.xml @ 11:91e663440ca4 draft

Uploaded
author greg
date Wed, 02 Dec 2015 20:32:21 -0500
parents 29082971b47c
children 34d134cd4ca9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
1 <?xml version="1.0"?>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
2 <tool id="repmatch_gff3" name="RepMatch" version="@WRAPPER_VERSION@.0">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
3 <description>Match paired peaks from two or more replicates</description>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
4 <macros>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
5 <import>repmatch_gff3_macros.xml</import>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
6 </macros>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
7 <expand macro="requirements" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
8 <command>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
9 python $__tool_directory__/repmatch_gff3.py
d33030c8e2cc Uploaded
greg
parents:
diff changeset
10 #for $i in $input:
d33030c8e2cc Uploaded
greg
parents:
diff changeset
11 --input "${i}" "${i.hid}"
d33030c8e2cc Uploaded
greg
parents:
diff changeset
12 #end for
d33030c8e2cc Uploaded
greg
parents:
diff changeset
13 --method $method
d33030c8e2cc Uploaded
greg
parents:
diff changeset
14 --distance $distance
d33030c8e2cc Uploaded
greg
parents:
diff changeset
15 --replicates $replicates
d33030c8e2cc Uploaded
greg
parents:
diff changeset
16 --output_files $output_files_cond.output_files
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
17 --output_matched_peaks "$output_matched_peaks"
29082971b47c Uploaded
greg
parents: 7
diff changeset
18 #if str($output_files_cond.output_files) in ["all", "matched_peaks_unmatched_peaks"]:
29082971b47c Uploaded
greg
parents: 7
diff changeset
19 --output_unmatched_peaks "$output_unmatched_peaks"
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
20 #end if
d33030c8e2cc Uploaded
greg
parents:
diff changeset
21 #if str($output_files_cond.output_files) =="all":
d33030c8e2cc Uploaded
greg
parents:
diff changeset
22 --output_detail "$output_detail"
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
23 --output_statistics_table "$output_statistics_table"
29082971b47c Uploaded
greg
parents: 7
diff changeset
24 --output_statistics_histogram "$output_statistics_histogram"
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
25 #end if
11
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
26 #if str($advanced_options_cond.advanced_options) == "on":
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
27 --step $advanced_options_cond.step
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
28 --low_limit $advanced_options_cond.low_limit
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
29 --up_limit $advanced_options_cond.up_limit
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
30 #end if
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
31 </command>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
32 <inputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
33 <param name="input" type="data" format="gff" multiple="True" min="2" label="Match paired peaks on" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
34 <param name="method" type="select" label="Method of finding match">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
35 <option value="closest" selected="True">Closest</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
36 <option value="largest">Largest</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
37 <option value="all">All</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
38 </param>
11
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
39 <param name="distance" type="integer" value="50" min="0" label="Maximum distance between peaks in different replicates to allow merging" />
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
40 <param name="replicates" type="integer" value="2" min="2" label="Minimum number of replicates that must be matched for merging to occur" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
41 <conditional name="output_files_cond">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
42 <param name="output_files" type="select" label="Restrict output to" help="Statistics will always be generated." >
d33030c8e2cc Uploaded
greg
parents:
diff changeset
43 <option value="all" selected="True">no restrictions (output everything)</option>
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
44 <option value="matched_peaks">matched paired peaks only</option>
29082971b47c Uploaded
greg
parents: 7
diff changeset
45 <option value="matched_peaks_unmatched_peaks">matched paired peaks and unmatched paired peaks only</option>
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
46 </param>
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
47 <when value="matched_peaks" />
29082971b47c Uploaded
greg
parents: 7
diff changeset
48 <when value="matched_peaks_unmatched_peaks" />
7
1807688a8a5f Uploaded
greg
parents: 4
diff changeset
49 <when value="all" />
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
50 </conditional>
11
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
51 <conditional name="advanced_options_cond">
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
52 <param name="advanced_options" type="select" label="Advanced options">
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
53 <option value="off" selected="true">Hide advanced options</option>
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
54 <option value="on">Display advanced options</option>
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
55 </param>
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
56 <when value="on">
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
57 <param name="step" type="integer" value="0" min="0" label="Step size" help="Distance for each iteration" />
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
58 <param name="low_limit" type="integer" value="-1000" label="Lower limit for Crick-Watson distance filter" />
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
59 <param name="up_limit" type="integer" value="1000" label="Upper limit for Crick-Watson distance filter" />
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
60 </when>
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
61 <when value="off" />
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
62 </conditional>
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
63 </inputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
64 <outputs>
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
65 <data name="output_statistics_table" format="tabular" label="Statistics Table: ${tool.name} on ${on_string}">
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
66 <filter>output_files_cond["output_files"] == "all"</filter>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
67 </data>
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
68 <data name="output_statistics_histogram" format="pdf" label="Statistics Histogram: ${tool.name} on ${on_string}">
29082971b47c Uploaded
greg
parents: 7
diff changeset
69 <filter>output_files_cond["output_files"] == "all"</filter>
29082971b47c Uploaded
greg
parents: 7
diff changeset
70 </data>
29082971b47c Uploaded
greg
parents: 7
diff changeset
71 <data name="output_detail" format="tabular" label="Data D: ${tool.name} on ${on_string}">
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
72 <filter>output_files_cond["output_files"] == "all"</filter>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
73 </data>
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
74 <data name="output_unmatched_peaks" format="tabular" label="Data UP: ${tool.name} on ${on_string}">
29082971b47c Uploaded
greg
parents: 7
diff changeset
75 <filter>output_files_cond["output_files"] in ["all", "matched_peaks_unmatched_peaks"]</filter>
29082971b47c Uploaded
greg
parents: 7
diff changeset
76 </data>
29082971b47c Uploaded
greg
parents: 7
diff changeset
77 <data name="output_matched_peaks" format="gff" label="Data MP: ${tool.name} on ${on_string}" />
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
78 </outputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
79 <tests>
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
80 <param name="input" value="closest_matched_pairs_input1.gff" ftype="gff" />
29082971b47c Uploaded
greg
parents: 7
diff changeset
81 <param name="input" value="largest_matched_pairs_input1.gff" ftype="gff" />
11
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
82 <param name="method" value="closest" />
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
83 <param name="distance" value="50" />
11
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
84 <param name="replicates" value="2" />
91e663440ca4 Uploaded
greg
parents: 10
diff changeset
85 <param name="output_files" value="all" />
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
86 <param name="step" value="0" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
87 <param name="low_limit" value="-1000" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
88 <param name="up_limit" value="1000" />
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
89 <output name="output_statistics_table" file="statistics_table_out1.tabular" ftype="tabular" />
29082971b47c Uploaded
greg
parents: 7
diff changeset
90 <output name="output_statistics_histogram" file="statistics_histogram_out1.pdf" ftype="pdf" compare="sim_size" />
29082971b47c Uploaded
greg
parents: 7
diff changeset
91 <output name="output_detail" file="detail_out1.tabular" ftype="tabular" />
29082971b47c Uploaded
greg
parents: 7
diff changeset
92 <output name="output_unmatched_peaks" file="unmatched_peaks_out1.tabular" ftype="tabular" />
29082971b47c Uploaded
greg
parents: 7
diff changeset
93 <output name="output_matched_peaks" file="matched_peaks_out1.gff" ftype="gff" />
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
94 </tests>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
95 <help>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
96 **What it does**
d33030c8e2cc Uploaded
greg
parents:
diff changeset
97
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
98 Replicate matching - inspects paired peaks from two or more replicates and produces a list of matched
29082971b47c Uploaded
greg
parents: 7
diff changeset
99 paired peaks and optionally a list of unmatched paired peaks. Additional optional outputs include the
29082971b47c Uploaded
greg
parents: 7
diff changeset
100 median read count for each input, details and a histogram.
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
101
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
102 -----
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
103
d33030c8e2cc Uploaded
greg
parents:
diff changeset
104 **Options**
d33030c8e2cc Uploaded
greg
parents:
diff changeset
105
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
106 * **Distance** - Maximum distance between peaks in different replicates to allow merging.
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
107 * **Method** - Method to use when calling replicates.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
108 * **Step Size** - Distance for each iteration.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
109 * **Replicates** - Minimum number of replicates to call a peak. Number of replicates required must be at least 2.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
110 * **Lower Limit** - Lower limit for the Crick-Watson distance filter.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
111 * **Upper Limit** - Upper limit for the Crick-Watson distance filter.
10
29082971b47c Uploaded
greg
parents: 7
diff changeset
112
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
113 </help>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
114 <expand macro="citations" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
115 </tool>