annotate SMART/galaxy/clusterizeBySlidingWindows.xml @ 36:44d5973c188c

Uploaded
author m-zytnicki
date Tue, 30 Apr 2013 15:02:29 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
36
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
1 <tool id="clusterizeBySlidingWindows" name="clusterize By SlidingWindows">
44d5973c188c 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>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
3 <command interpreter="python">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
4 ../Java/Python/clusterizeBySlidingWindows.py -i $formatType.inputFileName
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
5 #if $formatType.FormatInputFileName == 'bed':
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
6 -f bed
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
7 #elif $formatType.FormatInputFileName == 'gff':
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
8 -f gff
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
9 #elif $formatType.FormatInputFileName == 'gff2':
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
10 -f gff2
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
11 #elif $formatType.FormatInputFileName == 'gff3':
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
12 -f gff3
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
13 #elif $formatType.FormatInputFileName == 'sam':
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
14 -f sam
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
15 #elif $formatType.FormatInputFileName == 'gtf':
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
16 -f gtf
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
17 #end if
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
18 -s $size
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
19 -e $overlap
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
20 -o $outputFileGff
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
21 $normalize
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
22 $strands
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
23
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
24 #if $OptionTag.tag == "Yes":
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
25 -g $OptionTag.value
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
26 #end if
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
27
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
28 #if $OptionsOperation.operation == "Yes":
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
29 -r $OptionsOperation.value
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
30 #end if
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
31
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
32 #if $OptionWriteTag.writeTag == "Yes":
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
33 -w $OptionWriteTag.value
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
34 #end if
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
35
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
36 $strand
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
37 $plot $plotPng
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
38 $excel $excelOutput
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
39
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
40
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
41 </command>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
42
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
43 <inputs>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
44 <conditional name="formatType">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
45 <param name="FormatInputFileName" type="select" label="Input File Format">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
46 <option value="bed">bed</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
47 <option value="gff">gff</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
48 <option value="gff2">gff2</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
49 <option value="gff3">gff3</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
50 <option value="sam">sam</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
51 <option value="gtf">gtf</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
52 </param>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
53 <when value="bed">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
54 <param name="inputFileName" format="bed" type="data" label="Input File"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
55 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
56 <when value="gff">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
57 <param name="inputFileName" format="gff" type="data" label="Input File"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
58 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
59 <when value="gff2">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
60 <param name="inputFileName" format="gff2" type="data" label="Input File"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
61 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
62 <when value="gff3">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
63 <param name="inputFileName" format="gff3" type="data" label="Input File"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
64 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
65 <when value="sam">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
66 <param name="inputFileName" format="sam" type="data" label="Input File"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
67 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
68 <when value="gtf">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
69 <param name="inputFileName" format="gtf" type="data" label="Input File"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
70 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
71 </conditional>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
72
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
73
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
74 <param name="size" type="text" value="50000" label="Size option" help="Size of the regions."/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
75 <param name="overlap" type="text" value="50" label="Overlap option" help="Overlap between two consecutive regions."/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
76 <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)"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
77 <param name="strands" type="boolean" truevalue="-2" falsevalue="" checked="false" label="Consider the two strands separately"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
78
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
79 <conditional name="OptionTag">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
80 <param name="tag" type="select" label="Use a given tag as input (instead of summing number of features)">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
81 <option value="Yes">Yes</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
82 <option value="No" selected="true">No</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
83 </param>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
84 <when value="Yes">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
85 <param name="value" type="select" label="tag name"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
86 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
87 <when value="No">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
88 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
89 </conditional>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
90
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
91
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
92 <conditional name="OptionsOperation">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
93 <param name="operation" type="select" label="combine tag value with given operation">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
94 <option value="Yes">Yes</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
95 <option value="No" selected="true">No</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
96 </param>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
97 <when value="Yes">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
98 <param name="value" type="select" label="operation" help="You can ONLY choose one of following operation : sum, avg, med, min, max.">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
99 <option value="sum">sum</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
100 <option value="avg">average</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
101 <option value="med">median</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
102 <option value="min">minimum</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
103 <option value="max">maximum</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
104 </param>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
105 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
106 <when value="No">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
107 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
108 </conditional>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
109
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
110
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
111 <conditional name="OptionWriteTag">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
112 <param name="writeTag" type="select" label="write a new tag in output file">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
113 <option value="Yes">Yes</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
114 <option value="No" selected="true">No</option>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
115 </param>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
116 <when value="Yes">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
117 <param name="value" type="text" value="nbElements" label="write tag option" help="print the result in the given tag (default usually is 'nbElements')"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
118 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
119 <when value="No">
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
120 </when>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
121 </conditional>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
122
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
123 </inputs>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
124
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
125 <outputs>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
126 <data name="outputFileGff" format="gff3"/>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
127 </outputs>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
128
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
129 <help>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
130 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.
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
131
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
132 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.
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
133
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
134 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**).
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
135
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
136 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.
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
137 </help>
44d5973c188c Uploaded
m-zytnicki
parents:
diff changeset
138 </tool>