annotate SMART/galaxy/clusterizeBySlidingWindows.xml @ 39:1236e5a49595

Uploaded
author m-zytnicki
date Mon, 13 May 2013 10:22:25 -0400
parents 2c0c0a89fad7
children 5f5c9b74c2dd
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">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
7 ../Java/Python/clusterizeBySlidingWindows.py -i $formatType.inputFileName
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
8 #if $formatType.FormatInputFileName == 'bed':
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
9 -f bed
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
10 #elif $formatType.FormatInputFileName == 'gff':
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
11 -f gff
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
12 #elif $formatType.FormatInputFileName == 'gff2':
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
13 -f gff2
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
14 #elif $formatType.FormatInputFileName == 'gff3':
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
15 -f gff3
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
16 #elif $formatType.FormatInputFileName == 'sam':
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
17 -f sam
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
18 #elif $formatType.FormatInputFileName == 'gtf':
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
19 -f gtf
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
20 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
21 -s $size
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
22 -e $overlap
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
23 -o $outputFileGff
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
24 $normalize
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
25 $strands
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
26
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
27 #if $OptionTag.tag == "Yes":
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
28 -g $OptionTag.value
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
29 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
30
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
31 #if $OptionsOperation.operation == "Yes":
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
32 -r $OptionsOperation.value
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
33 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
34
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
35 #if $OptionWriteTag.writeTag == "Yes":
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
36 -w $OptionWriteTag.value
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
37 #end if
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
38
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
39 $strand
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
40 $plot $plotPng
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
41 $excel $excelOutput
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
42
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
43
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
44 </command>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
45
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
46 <inputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
47 <conditional name="formatType">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
48 <param name="FormatInputFileName" type="select" label="Input File Format">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
49 <option value="bed">bed</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
50 <option value="gff">gff</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
51 <option value="gff2">gff2</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
52 <option value="gff3">gff3</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
53 <option value="sam">sam</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
54 <option value="gtf">gtf</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
55 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
56 <when value="bed">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
57 <param name="inputFileName" format="bed" type="data" label="Input File"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
58 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
59 <when value="gff">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
60 <param name="inputFileName" format="gff" type="data" label="Input File"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
61 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
62 <when value="gff2">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
63 <param name="inputFileName" format="gff2" type="data" label="Input File"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
64 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
65 <when value="gff3">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
66 <param name="inputFileName" format="gff3" type="data" label="Input File"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
67 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
68 <when value="sam">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
69 <param name="inputFileName" format="sam" type="data" label="Input File"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
70 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
71 <when value="gtf">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
72 <param name="inputFileName" format="gtf" type="data" label="Input File"/>
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
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
77 <param name="size" type="text" value="50000" label="Size option" help="Size of the regions."/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
78 <param name="overlap" type="text" value="50" label="Overlap option" help="Overlap between two consecutive regions."/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
79 <param name="normalize" type="boolean" truevalue="-m" falsevalue="" checked="false" label="Normalize option for only GFF3 file format" help="(only work if the tag nbOccurrences is set)"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
80 <param name="strands" type="boolean" truevalue="-2" falsevalue="" checked="false" label="Consider the two strands separately"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
81
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
82 <conditional name="OptionTag">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
83 <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
84 <option value="Yes">Yes</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
85 <option value="No" selected="true">No</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
86 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
87 <when value="Yes">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
88 <param name="value" type="select" label="tag name"/>
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
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
95 <conditional name="OptionsOperation">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
96 <param name="operation" type="select" label="combine tag value with given operation">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
97 <option value="Yes">Yes</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
98 <option value="No" selected="true">No</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
99 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
100 <when value="Yes">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
101 <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
102 <option value="sum">sum</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
103 <option value="avg">average</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
104 <option value="med">median</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
105 <option value="min">minimum</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
106 <option value="max">maximum</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
107 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
108 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
109 <when value="No">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
110 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
111 </conditional>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
112
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
113
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
114 <conditional name="OptionWriteTag">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
115 <param name="writeTag" type="select" label="write a new tag in output file">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
116 <option value="Yes">Yes</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
117 <option value="No" selected="true">No</option>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
118 </param>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
119 <when value="Yes">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
120 <param name="value" type="text" value="nbElements" label="write tag option" help="print the result in the given tag (default usually is 'nbElements')"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
121 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
122 <when value="No">
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
123 </when>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
124 </conditional>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
125
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
126 </inputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
127
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
128 <outputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
129 <data name="outputFileGff" format="gff3"/>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
130 </outputs>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
131
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
132 <help>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
133 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
134
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
135 By default, sliding windows count the number of reads in each window. However, you can basically 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.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
136
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
137 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
138
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
139 You also have different option, which can select the *n* % highest regions, or the regions with at least *n* features in it, or even the regions with at least *n* unique features. This last option is useful when you want to cluster the reads which have mapped only once, for instance.
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
140 </help>
2c0c0a89fad7 Uploaded
m-zytnicki
parents:
diff changeset
141 </tool>