annotate genetrack.xml @ 10:1a9f1a4fa36c draft

Uploaded
author greg
date Wed, 02 Dec 2015 16:14:58 -0500
parents fa85ca6c9cf8
children 497e3274f70b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
0368815ae4d5 Uploaded
greg
parents:
diff changeset
1 <?xml version="1.0"?>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
2 <tool id="genetrack" name="Genetrack" version="@WRAPPER_VERSION@.0">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
3 <description>peak predictor</description>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
4 <macros>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
5 <import>genetrack_macros.xml</import>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
6 </macros>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
7 <expand macro="requirements" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
8 <command>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
9 python $__tool_directory__/genetrack.py
0368815ae4d5 Uploaded
greg
parents:
diff changeset
10 --input_format $input_format_cond.input_format
6
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
11 #if str($input_format_cond.input_format) == "scidx":
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
12 #for $i in $input_format_cond.input_scidx:
0
0368815ae4d5 Uploaded
greg
parents:
diff changeset
13 --input "${i}" "${i.hid}"
0368815ae4d5 Uploaded
greg
parents:
diff changeset
14 #end for
0368815ae4d5 Uploaded
greg
parents:
diff changeset
15 #elif str($input_format_cond.input_format) == "gff":
0368815ae4d5 Uploaded
greg
parents:
diff changeset
16 #for $i in $input_format_cond.input_gff:
0368815ae4d5 Uploaded
greg
parents:
diff changeset
17 --input "${i}" "${i.hid}"
0368815ae4d5 Uploaded
greg
parents:
diff changeset
18 #end for
0368815ae4d5 Uploaded
greg
parents:
diff changeset
19 #end if
0368815ae4d5 Uploaded
greg
parents:
diff changeset
20 --sigma $sigma
0368815ae4d5 Uploaded
greg
parents:
diff changeset
21 --exclusion $exclusion
0368815ae4d5 Uploaded
greg
parents:
diff changeset
22 --up_width $up_width
0368815ae4d5 Uploaded
greg
parents:
diff changeset
23 --down_width $down_width
0368815ae4d5 Uploaded
greg
parents:
diff changeset
24 --filter $filter
0368815ae4d5 Uploaded
greg
parents:
diff changeset
25 --chunk_size $chunk_size
0368815ae4d5 Uploaded
greg
parents:
diff changeset
26 </command>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
27 <inputs>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
28 <conditional name="input_format_cond">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
29 <param name="input_format" type="select" label="Format of files for conversion">
6
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
30 <option value="scidx" selected="True">ScIdx</option>
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
31 <option value="gff">Gff</option>
0
0368815ae4d5 Uploaded
greg
parents:
diff changeset
32 </param>
6
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
33 <when value="scidx">
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
34 <param name="input_scidx" type="data" format="scidx" multiple="True" label="Predict peaks on" />
0
0368815ae4d5 Uploaded
greg
parents:
diff changeset
35 </when>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
36 <when value="gff">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
37 <param name="input_gff" type="data" format="gff" multiple="True" label="Predict peaks on" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
38 </when>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
39 </conditional>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
40 <param name="sigma" type="integer" value="5" min="1" label="Sigma to use when smoothing reads" help="Higher values increase computation but produce more smoothing." />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
41 <param name="exclusion" type="integer" value="20" min="1" label="Peak exclusion zone" help="Exclusion zone around each peak that prevents others from being called." />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
42 <param name="up_width" type="integer" value="10" min="0" label="Upstream width of called peaks" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
43 <param name="down_width" type="integer" value="10" min="0" label="Downstream width of called peaks" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
44 <param name="filter" type="integer" value="3" min="0" label="Absolute read filter" help="Removes peaks with lower peak height." />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
45 <param name="chunk_size" type="integer" value="10" min="1" label="Chunk each chromosome into" help="Value is millions of base pairs where each size increment uses about 20MB of memory." />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
46 </inputs>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
47 <outputs>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
48 <collection name="genetrack_output" type="list" label="Genetrack results on ${on_string}">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
49 <discover_datasets pattern="(?P&lt;designation&gt;.*)" directory="output" ext="gff" visible="false" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
50 </collection>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
51 </outputs>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
52 <tests>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
53 <test>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
54 <param name="input_gff" value="genetrack_input2.gff" ftype="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
55 <param name="input_format" value="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
56 <param name="sigma" value="5" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
57 <param name="exclusion" value="20" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
58 <param name="up_width" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
59 <param name="down_width" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
60 <param name="filter" value="3" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
61 <param name="chunk_size" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
62 <output_collection name="genetrack_output" type="list">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
63 <element name="s5e20u10d10F3_on_data_1" file="genetrack_output2.gff" ftype="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
64 </output_collection>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
65 </test>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
66 <test>
6
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
67 <param name="input_scidx" value="genetrack_input3.scidx" ftype="scidx" />
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
68 <param name="input_format" value="scidx" />
0
0368815ae4d5 Uploaded
greg
parents:
diff changeset
69 <param name="sigma" value="5" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
70 <param name="exclusion" value="20" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
71 <param name="up_width" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
72 <param name="down_width" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
73 <param name="filter" value="3" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
74 <param name="chunk_size" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
75 <output_collection name="genetrack_output" type="list">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
76 <element name="s5e20u10d10F3_on_data_1" file="genetrack_output3.gff" ftype="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
77 </output_collection>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
78 </test>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
79 <test>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
80 <param name="input_gff" value="genetrack_input_unsorted4.gff" ftype="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
81 <param name="input_format" value="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
82 <param name="sigma" value="5" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
83 <param name="exclusion" value="20" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
84 <param name="up_width" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
85 <param name="down_width" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
86 <param name="filter" value="3" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
87 <param name="chunk_size" value="10" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
88 <output_collection name="genetrack_output" type="list">
0368815ae4d5 Uploaded
greg
parents:
diff changeset
89 <element name="s5e20u10d10F3_on_data_1" file="genetrack_output4.gff" ftype="gff" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
90 </output_collection>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
91 </test>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
92 </tests>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
93 <help>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
94 **What it does**
0368815ae4d5 Uploaded
greg
parents:
diff changeset
95
0368815ae4d5 Uploaded
greg
parents:
diff changeset
96 Genetrack takes a standard set of data on both the sense and antisense strands and smooths their relative reads.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
97 It then calls the peaks present in the smoothed dataset and uses those peak locations to calculate the final
0368815ae4d5 Uploaded
greg
parents:
diff changeset
98 reads from surrounding reads. Finally, it ensures each peak is above a threshold and that two peaks are not
0368815ae4d5 Uploaded
greg
parents:
diff changeset
99 too close to each other.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
100
6
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
101 -----
fa85ca6c9cf8 Uploaded
greg
parents: 3
diff changeset
102
0
0368815ae4d5 Uploaded
greg
parents:
diff changeset
103 **Options**
0368815ae4d5 Uploaded
greg
parents:
diff changeset
104
0368815ae4d5 Uploaded
greg
parents:
diff changeset
105 * **Sigma to use when smoothing reads** - Sigma to use when smoothing reads to call peaks.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
106 * **Peak exclusion zone** - Exclusion zone around each peak that prevents others from being called.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
107 * **Upstream width of called peaks** - Upstream width of called peaks.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
108 * **Downstream width of called peaks** - Downstream width of called peaks.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
109 * **Filter** - Absolute read filter. Restricts output to only peaks with larger peak height.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
110 * **Chunk each chromosome into** - Size, in millions of base pairs, to chunk each chromosome when processing. Each 1 million size uses approximately 20MB of memory.
0368815ae4d5 Uploaded
greg
parents:
diff changeset
111 </help>
0368815ae4d5 Uploaded
greg
parents:
diff changeset
112 <expand macro="citations" />
0368815ae4d5 Uploaded
greg
parents:
diff changeset
113 </tool>