annotate repmatch_gff3.xml @ 6:6df81aade62c draft

Uploaded
author greg
date Sat, 28 Nov 2015 14:54:33 -0500
parents 1cea96c461a2
children 1807688a8a5f
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 --step $step
d33030c8e2cc Uploaded
greg
parents:
diff changeset
16 --replicates $replicates
d33030c8e2cc Uploaded
greg
parents:
diff changeset
17 --low_limit $low_limit
d33030c8e2cc Uploaded
greg
parents:
diff changeset
18 --up_limit $up_limit
d33030c8e2cc Uploaded
greg
parents:
diff changeset
19 --output_files $output_files_cond.output_files
d33030c8e2cc Uploaded
greg
parents:
diff changeset
20 --output_summary "$output_summary"
d33030c8e2cc Uploaded
greg
parents:
diff changeset
21 #if str($output_files_cond.output_files) in ["all", "simple_orphan"]:
d33030c8e2cc Uploaded
greg
parents:
diff changeset
22 --output_orphan "$output_orphan"
d33030c8e2cc Uploaded
greg
parents:
diff changeset
23 #end if
d33030c8e2cc Uploaded
greg
parents:
diff changeset
24 #if str($output_files_cond.output_files) =="all":
d33030c8e2cc Uploaded
greg
parents:
diff changeset
25 --plot_format $output_files_cond.plot_format
d33030c8e2cc Uploaded
greg
parents:
diff changeset
26 --output_detail "$output_detail"
d33030c8e2cc Uploaded
greg
parents:
diff changeset
27 --output_key "$output_key"
d33030c8e2cc Uploaded
greg
parents:
diff changeset
28 --output_histogram "$output_histogram"
d33030c8e2cc Uploaded
greg
parents:
diff changeset
29 #end if
d33030c8e2cc Uploaded
greg
parents:
diff changeset
30 </command>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
31 <inputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
32 <param name="input" type="data" format="gff" multiple="True" min="2" label="Match paired peaks on" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
33 <param name="method" type="select" label="Method of finding match">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
34 <option value="closest" selected="True">Closest</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
35 <option value="largest">Largest</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
36 <option value="all">All</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
37 </param>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
38 <param name="distance" type="integer" value="50" min="0" label="Maximum distance between peaks in different replicates to allow merging" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
39 <param name="step" type="integer" value="0" min="0" label="Step size" help="Distance for each iteration" />
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 <param name="low_limit" type="integer" value="-1000" label="Lower limit for Crick-Watson distance filter" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
42 <param name="up_limit" type="integer" value="1000" label="Upper limit for Crick-Watson distance filter" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
43 <conditional name="output_files_cond">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
44 <param name="output_files" type="select" label="Restrict output to" help="Statistics will always be generated." >
d33030c8e2cc Uploaded
greg
parents:
diff changeset
45 <option value="all" selected="True">no restrictions (output everything)</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
46 <option value="simple">matched pairs only</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
47 <option value="simple_orphan">matched pairs and orphans only</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
48 </param>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
49 <when value="simple" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
50 <when value="simple_orphan" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
51 <when value="all">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
52 <param name="plot_format" type="select" label="Output format for graph">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
53 <option value="pdf" selected="True">Pdf</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
54 <option value="png">Png</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
55 <option value="svg">Svg</option>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
56 </param>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
57 </when>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
58 </conditional>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
59 </inputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
60 <outputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
61 <data name="output_summary" format="gff" label="Matched pairs: ${tool.name} on ${on_string}" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
62 <data name="output_orphan" format="tabular" label="Orphans: ${tool.name} on ${on_string}">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
63 <filter>output_files_cond["output_files"] in ["all", "simple_orphan"]</filter>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
64 </data>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
65 <data name="output_detail" format="tabular" label="Details: ${tool.name} on ${on_string}">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
66 <filter>output_files_cond["output_files"] == "all"</filter>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
67 </data>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
68 <data name="output_key" format="tabular" label="Key: ${tool.name} on ${on_string}">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
69 <filter>output_files_cond["output_files"] == "all"</filter>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
70 </data>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
71 <data name="output_histogram" format="pdf" label="Histogram: ${tool.name} on ${on_string}">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
72 <filter>output_files_cond["output_files"] == "all"</filter>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
73 <actions>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
74 <action type="format">
d33030c8e2cc Uploaded
greg
parents:
diff changeset
75 <option type="from_param" name="output_files_cond.plot_format" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
76 </action>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
77 </actions>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
78 </data>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
79 </outputs>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
80 <tests>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
81 <param name="input" value="closest_s_input1.gff" ftype="gff" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
82 <param name="input" value="largest_s_input1.gff" ftype="gff" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
83 <param name="method" value="closest" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
84 <param name="distance" value="50" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
85 <param name="step" value="0" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
86 <param name="replicates" value="2" />
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" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
89 <param name="output_files" value="all" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
90 <param name="plot_format" value="png" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
91 <output name="output_summary" file="summary_out1.gff" ftype="gff" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
92 <output name="output_orphan" file="orphan_out1.tabular" ftype="tabular" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
93 <output name="output_detail" file="orphan_detail1.tabular" ftype="tabular" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
94 <output name="output_key" file="key_out1.tabular" ftype="tabular" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
95 <output name="output_histogram" file="histogram_out1.pdf" ftype="pdf" compare="sim_size" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
96 </tests>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
97 <help>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
98 **What it does**
d33030c8e2cc Uploaded
greg
parents:
diff changeset
99 <![CDATA[
d33030c8e2cc Uploaded
greg
parents:
diff changeset
100
4
1cea96c461a2 Uploaded
greg
parents: 0
diff changeset
101 Replicate matching - matches paired peaks from two or more replicates and produces a list of matched
0
d33030c8e2cc Uploaded
greg
parents:
diff changeset
102 groups and optionally a list of matched orphans. Additional optional outputs include the median read
d33030c8e2cc Uploaded
greg
parents:
diff changeset
103 count for each input, details and a histogram.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
104
d33030c8e2cc Uploaded
greg
parents:
diff changeset
105 ]]>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
106
d33030c8e2cc Uploaded
greg
parents:
diff changeset
107 **Options**
d33030c8e2cc Uploaded
greg
parents:
diff changeset
108
d33030c8e2cc Uploaded
greg
parents:
diff changeset
109 * **Method** - Method to use when calling replicates.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
110 * **Distance** - Maximum distance between peaks in different replicates to allow merging.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
111 * **Step Size** - Distance for each iteration.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
112 * **Replicates** - Minimum number of replicates to call a peak. Number of replicates required must be at least 2.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
113 * **Lower Limit** - Lower limit for the Crick-Watson distance filter.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
114 * **Upper Limit** - Upper limit for the Crick-Watson distance filter.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
115 * **Plot Format** - Output format for graph. The options are PNG or SVG.
d33030c8e2cc Uploaded
greg
parents:
diff changeset
116 </help>
d33030c8e2cc Uploaded
greg
parents:
diff changeset
117 <expand macro="citations" />
d33030c8e2cc Uploaded
greg
parents:
diff changeset
118 </tool>