comparison SMART/galaxy/CompareOverlappingSmallQuery.xml @ 38:2c0c0a89fad7

Uploaded
author m-zytnicki
date Thu, 02 May 2013 09:56:47 -0400
parents
children 97aa2e42bfdf
comparison
equal deleted inserted replaced
37:d22fadc825e3 38:2c0c0a89fad7
1 <tool id="CompareOverlappingSmallQuery" name="compare overlapping small query">
2 <description>Provide the queries that overlap with a reference, when the query data set is small.</description>
3 <requirements>
4 <requirement type="set_environment">PYTHONPATH</requirement>
5 </requirements>
6 <command interpreter="python">
7 ../Java/Python/CompareOverlappingSmallQuery.py -i $formatType.inputFileName1
8 #if $formatType.FormatInputFileName1 == 'bed':
9 -f bed
10 #elif $formatType.FormatInputFileName1 == 'gff':
11 -f gff
12 #elif $formatType.FormatInputFileName1 == 'gff2':
13 -f gff2
14 #elif $formatType.FormatInputFileName1 == 'gff3':
15 -f gff3
16 #elif $formatType.FormatInputFileName1 == 'sam':
17 -f sam
18 #elif $formatType.FormatInputFileName1 == 'gtf':
19 -f gtf
20 #end if
21 -j $formatType2.inputFileName2
22 #if $formatType2.FormatInputFileName2 == 'bed':
23 -g bed
24 #elif $formatType2.FormatInputFileName2 == 'gff':
25 -g gff
26 #elif $formatType2.FormatInputFileName2 == 'gff2':
27 -g gff2
28 #elif $formatType2.FormatInputFileName2 == 'gff3':
29 -g gff3
30 #elif $formatType2.FormatInputFileName2 == 'sam':
31 -g sam
32 #elif $formatType2.FormatInputFileName2 == 'gtf':
33 -g gtf
34 #end if
35 -o $outputFileGff
36 #if $OptionDistance.Dist == 'Yes':
37 -d $OptionDistance.distance
38 #end if
39 #if $OptionMinOverlap.present == 'Yes':
40 -m $OptionMinOverlap.minOverlap
41 #end if
42 #if $OptionPcOverlapQuery.present == 'Yes':
43 -p $OptionPcOverlapQuery.minOverlap
44 #end if
45 #if $OptionPcOverlapRef.present == 'Yes':
46 -P $OptionPcOverlapRef.minOverlap
47 #end if
48 #if $OptionCollinearOrAntiSens.OptionCA == 'Collinear':
49 -c
50 #elif $OptionCollinearOrAntiSens.OptionCA == 'AntiSens':
51 -a
52 #end if
53 $InvertMatch
54 $NotOverlapping
55 $OptionInclusionQuery
56 $OptionInclusionRef
57 </command>
58
59 <inputs>
60 <conditional name="formatType">
61 <param name="FormatInputFileName1" type="select" label="Input Query File Format">
62 <option value="bed">bed</option>
63 <option value="gff">gff</option>
64 <option value="gff2">gff2</option>
65 <option value="gff3">gff3</option>
66 <option value="sam">sam</option>
67 <option value="gtf">gtf</option>
68 </param>
69 <when value="bed">
70 <param name="inputFileName1" format="bed" type="data" label="Input File 1"/>
71 </when>
72 <when value="gff">
73 <param name="inputFileName1" format="gff" type="data" label="Input File 1"/>
74 </when>
75 <when value="gff2">
76 <param name="inputFileName1" format="gff2" type="data" label="Input File 1"/>
77 </when>
78 <when value="gff3">
79 <param name="inputFileName1" format="gff3" type="data" label="Input File 1"/>
80 </when>
81 <when value="sam">
82 <param name="inputFileName1" format="sam" type="data" label="Input File 1"/>
83 </when>
84 <when value="gtf">
85 <param name="inputFileName1" format="gtf" type="data" label="Input File 1"/>
86 </when>
87 </conditional>
88
89 <conditional name="formatType2">
90 <param name="FormatInputFileName2" type="select" label="Input Reference File Format">
91 <option value="bed">bed</option>
92 <option value="gff">gff</option>
93 <option value="gff2">gff2</option>
94 <option value="gff3">gff3</option>
95 <option value="sam">sam</option>
96 <option value="gtf">gtf</option>
97 </param>
98 <when value="bed">
99 <param name="inputFileName2" format="bed" type="data" label="Input File 2"/>
100 </when>
101 <when value="gff">
102 <param name="inputFileName2" format="gff" type="data" label="Input File 2"/>
103 </when>
104 <when value="gff2">
105 <param name="inputFileName2" format="gff2" type="data" label="Input File 2"/>
106 </when>
107 <when value="gff3">
108 <param name="inputFileName2" format="gff3" type="data" label="Input File 2"/>
109 </when>
110 <when value="sam">
111 <param name="inputFileName2" format="sam" type="data" label="Input File 2"/>
112 </when>
113 <when value="gtf">
114 <param name="inputFileName2" format="gtf" type="data" label="Input File 2"/>
115 </when>
116 </conditional>
117 <conditional name="OptionDistance">
118 <param name="Dist" type="select" label="Maximum Distance between two reads">
119 <option value="Yes">Yes</option>
120 <option value="No" selected="true">No</option>
121 </param>
122 <when value="Yes">
123 <param name="distance" type="integer" value="0"/>
124 </when>
125 <when value="No">
126 </when>
127 </conditional>
128 <conditional name="OptionMinOverlap">
129 <param name="present" type="select" label="Minimum number of common nucleotides to declare an overlap">
130 <option value="Yes">Yes</option>
131 <option value="No" selected="true">No</option>
132 </param>
133 <when value="Yes">
134 <param name="minOverlap" type="integer" value="0"/>
135 </when>
136 <when value="No">
137 </when>
138 </conditional>
139 <conditional name="OptionPcOverlapQuery">
140 <param name="present" type="select" label="N% of the query must overlap">
141 <option value="Yes">Yes</option>
142 <option value="No" selected="true">No</option>
143 </param>
144 <when value="Yes">
145 <param name="minOverlap" type="integer" value="0"/>
146 </when>
147 <when value="No">
148 </when>
149 </conditional>
150 <conditional name="OptionPcOverlapRef">
151 <param name="present" type="select" label="N% of the reference must overlap">
152 <option value="Yes">Yes</option>
153 <option value="No" selected="true">No</option>
154 </param>
155 <when value="Yes">
156 <param name="minOverlap" type="integer" value="0"/>
157 </when>
158 <when value="No">
159 </when>
160 </conditional>
161 <param name="OptionInclusionQuery" type="boolean" truevalue="-k" falsevalue="" checked="false" label="The query must be nested in a query"/>
162 <param name="OptionInclusionRef" type="boolean" truevalue="-K" falsevalue="" checked="false" label="The reference must be nested in a query"/>
163 <conditional name="OptionCollinearOrAntiSens">
164 <param name="OptionCA" type="select" label="Collinear or anti-sens">
165 <option value="Collinear">Collinear</option>
166 <option value="AntiSens">AntiSens</option>
167 <option value="NONE" selected="true">NONE</option>
168 </param>
169 <when value="Collinear">
170 </when>
171 <when value="AntiSens">
172 </when>
173 <when value="NONE">
174 </when>
175 </conditional>
176 <param name="InvertMatch" type="boolean" truevalue="-x" falsevalue="" checked="false" label="Invert match: the output file will contain all query elements which do NOT overlap"/>
177 <param name="NotOverlapping" type="boolean" truevalue="-O" falsevalue="" checked="false" label="Also report the query data which do not overlap, with the nbOverlaps tag set to 0."/>
178 </inputs>
179
180 <outputs>
181 <data name="outputFileGff" format="gff3"/>
182 </outputs>
183
184 <help>
185 This script may be the most important one. It basically compares two sets of transcripts and keeps those from the first set which overlap with the second one. The first set is considered as the query set (basically, your data) and the second one is the reference set (RefSeq data, for example).
186
187 It is vital to understand that it will output the elements of the first file which overlap with the elements of the second one.
188
189 Various modifiers are also available:
190
191 -Invert selection (report those which do not overlap).
192
193 -Restrict to colinear / anti-sense overlapping data.
194
195 -Keep the query data even if they do not strictly overlap with the reference data, but are located not further away than *n* nucleotide from some reference data.
196
197 -Keep the query data with are strictly included into reference data, meaning that a query transcript such that at least 1 nucleotide does not overlap with reference data will not be presented as a solution.
198
199 The mechanism of shrinking and extending is also useful to make a fine grain comparison. For example, if you want to keep those such that the TSS is overlapping the reference set, you just shrink the query set to 1 nucleotide. Now, if you want to keep those which are overlapping you data or located 2kb downstream of it, just extend the query data in the downstream direction, and you will have what you want. You can also extend in the opposite direction to get the possible transcript factor sites which are upstream.
200
201 Some option reverses the selection. Put in other words, it performs the comparison as usual, and outputs all those query data which do not overlap.
202 </help>
203 </tool>