annotate SMART/galaxy/clusterizeBySlidingWindows.xml @ 60:90f4b29d884f

Uploaded
author m-zytnicki
date Fri, 21 Feb 2014 08:32:36 -0500
parents 5f5c9b74c2dd
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
1 <tool id="clusterizeBySlidingWindows" name="clusterize by sliding windows">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
2 <description>Produces a GFF3 file that clusters a list of transcripts using a sliding window. Cluster the data into regions (defined by size and overlap with next region).</description>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
3 <requirements>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
4 <requirement type="set_environment">PYTHONPATH</requirement>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
5 </requirements>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
6 <command interpreter="python">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
7 #set $inputFiles = ",".join(["%s" % (s) for s in $formatType.inputFileName])
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
8 ../Java/Python/clusterizeBySlidingWindows.py -i $inputFiles -f $formatType.FormatInputFileName -s $size -e $overlap -o $outputFileGff $strands
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
9
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
10 #if $OptionTag.tag == "Yes":
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
11 -g $OptionTag.value
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
12 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
13
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
14 #if $OptionsOperation.operation == "Yes":
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
15 -r $OptionsOperation.value
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
16 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
17
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
18 #if $OptionWriteTag.writeTag == "Yes":
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
19 #set $outputTags = ",".join(["%s" % (t["value"]) for t in $OptionWriteTag.writeTags])
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
20 -w $outputTags
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
21 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
22
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
23 </command>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
24
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
25 <inputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
26 <conditional name="formatType">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
27 <param name="FormatInputFileName" type="select" label="Input File Format">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
28 <option value="bed">bed</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
29 <option value="gff">gff</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
30 <option value="gff2">gff2</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
31 <option value="gff3">gff3</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
32 <option value="sam">sam</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
33 <option value="gtf">gtf</option>
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
34 <option value="bam">bam</option>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
35 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
36 <when value="bed">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
37 <param name="inputFileName" format="bed" type="data" multiple="true" label="Input File"/>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
38 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
39 <when value="gff">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
40 <param name="inputFileName" format="gff" type="data" multiple="true" label="Input File"/>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
41 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
42 <when value="gff2">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
43 <param name="inputFileName" format="gff2" type="data" multiple="true" label="Input File"/>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
44 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
45 <when value="gff3">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
46 <param name="inputFileName" format="gff3" type="data" multiple="true" label="Input File"/>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
47 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
48 <when value="sam">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
49 <param name="inputFileName" format="sam" type="data" multiple="true" label="Input File"/>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
50 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
51 <when value="gtf">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
52 <param name="inputFileName" format="gtf" type="data" multiple="true" label="Input File"/>
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
53 </when>
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
54 <when value="bam">
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
55 <param name="inputFileName" format="bam" type="data" multiple="true" label="Input File"/>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
56 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
57 </conditional>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
58
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
59
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
60 <param name="size" type="text" value="50000" label="Size option" help="Size of the regions."/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
61 <param name="overlap" type="text" value="50" label="Overlap option" help="Overlap between two consecutive regions."/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
62 <param name="strands" type="boolean" truevalue="-2" falsevalue="" checked="false" label="Consider the two strands separately"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
63
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
64 <conditional name="OptionTag">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
65 <param name="tag" type="select" label="Use a given tag as input (instead of summing number of features)">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
66 <option value="Yes">Yes</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
67 <option value="No" selected="true">No</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
68 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
69 <when value="Yes">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
70 <param name="value" type="select" label="tag name"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
71 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
72 <when value="No">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
73 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
74 </conditional>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
75
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
76 <conditional name="OptionsOperation">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
77 <param name="operation" type="select" label="combine tag value with given operation">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
78 <option value="Yes">Yes</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
79 <option value="No" selected="true">No</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
80 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
81 <when value="Yes">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
82 <param name="value" type="select" label="operation" help="You can ONLY choose one of following operation : sum, avg, med, min, max.">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
83 <option value="sum">sum</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
84 <option value="avg">average</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
85 <option value="med">median</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
86 <option value="min">minimum</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
87 <option value="max">maximum</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
88 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
89 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
90 <when value="No">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
91 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
92 </conditional>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
93
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
94 <conditional name="OptionWriteTag">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
95 <param name="writeTag" type="select" label="use given tag in output file">
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
96 <option value="Yes">Yes</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
97 <option value="No" selected="true">No</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
98 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
99 <when value="Yes">
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
100 <repeat name="writeTags" title="Output Tag" min="1">
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
101 <param name="value" type="text" value="nbElements" label="write tag option" help="print the result in the given tag (default usually is 'nbElements')"/>
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
102 </repeat>
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
103 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
104 <when value="No">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
105 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
106 </conditional>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
107
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
108 </inputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
109
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
110 <outputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
111 <data name="outputFileGff" format="gff3"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
112 </outputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
113
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
114 <help>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
115 Sliding windows are a convenient ways to clusterize data mapped on the genome. There are two important parameters of a sliding window: the size of the window and the size of the overlap.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
116
58
5f5c9b74c2dd Uploaded
m-zytnicki
parents: 38
diff changeset
117 By default, sliding windows count the number of reads in each window of each input file. However, you can merge any information which is contained in the tags. You can compute the average, sum, median, max or min of the tags for each window. For instance, every window can contain the average cluster size, if you merge clusters instead of reads.
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
118
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
119 The output file is a GFF3 file, where each element is a window. There is a special tag for each window, whose name is **nbElements** if you counted the number of transcripts per sliding window. However, if you performed a **min** (resp. **max**, **sum**, **median**, **average**) operation on the tags **value** of the transcripts, then the tag of the window will be **minValue** (resp. **maxValue**, **sumValue**, **medValue**, **avgValue**). You can also specify the name of your tag (which is actually advised: **nbReadsInSample1** will always be more informative than **nbElements**).
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
120 </help>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
121 </tool>