annotate SMART/galaxy/clusterizeBySlidingWindows.xml @ 26:a6a9d9b94ddb

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