annotate multiIntersectBed.xml @ 12:c782e0edc4f1 draft default tip

Uploaded
author bgruening
date Thu, 19 Jun 2014 10:12:00 -0400
parents b78d20957e7f
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
c782e0edc4f1 Uploaded
bgruening
parents: 5
diff changeset
1 <tool id="bedtools_multiintersectbed" name="Intersect multiple sorted BED files" version="@WRAPPER_VERSION@.0">
5
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
9 multiIntersectBed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
10 $header
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
11 #if $zero.value == True:
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
12 -empty
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
13 -g ${chromInfo}
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
14 #end if
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
15
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
16 -i '$input1'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
17 '$input2'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
18 #for $q in $beds
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
19 '${q.input}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
20 #end for
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
21
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
22 -names
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
23 #if $name1.choice == "tag":
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
24 '${input1.name}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
25 #else
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
26 '${name1.custom_name}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
27 #end if
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
28
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
29 #if $name2.choice == "tag":
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
30 '${input2.name}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
31 #else
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
32 '${name2.custom_name}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
33 #end if
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
34
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
35 #for $q in $beds
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
36 #if $q.name.choice == "tag":
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
37 '${q.input.name}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
38 #else
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
39 '${q.input.custom_name}'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
40 #end if
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
41 #end for
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
42 &gt; '$output'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
43 </command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
44
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
45 <inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
46 <!-- Make it easy for the user, first two input files are always shown -->
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
47 <!-- INPUT 1 -->
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
48 <param name="input1" format="bed" type="data" label="First sorted BED file" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
49
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
50 <conditional name="name1">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
51 <param name="choice" type="select" label="Sample name">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
52 <option value="tag" selected="true">Use input's tag</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
53 <option value="custom">Enter custom table name</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
54 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
55 <when value="tag">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
56 </when>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
57 <when value="custom">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
58 <param name="custom_name" type="text" area="false" label="Custom sample name"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
59 </when>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
60 </conditional>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
61
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
62 <!-- INPUT 2 -->
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
63 <param name="input2" format="bed" type="data" label="Second sorted BED file" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
64
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
65 <conditional name="name2">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
66 <param name="choice" type="select" label="Sample name">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
67 <option value="tag" selected="true">Use input's tag</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
68 <option value="custom">Enter custom table name</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
69 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
70 <when value="tag">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
71 </when>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
72 <when value="custom">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
73 <param name="custom_name" type="text" area="false" label="Custom sample name"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
74 </when>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
75 </conditional>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
76
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
77 <!-- Additional files, if the user needs more -->
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
78 <repeat name="beds" title="Add'l sorted BED files" >
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
79 <param name="input" format="bed" type="data" label="BED file" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
80
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
81 <conditional name="name">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
82 <param name="choice" type="select" label="Sample name">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
83 <option value="tag" selected="true">Use input's tag</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
84 <option value="custom">Enter custom table name</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
85 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
86 <when value="tag">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
87 </when>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
88 <when value="custom">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
89 <param name="custom_name" type="text" area="false" label="Custom sample name"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
90 </when>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
91 </conditional>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
92 </repeat>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
93
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
94 <param name="header" type="boolean" checked="true" truevalue="-header" falsevalue="" label="Print header line" help="The first line will include the name of each sample." />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
95
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
96 <param name="zero" type="boolean" checked="true" label="Report regions that are not covered by any of the files" help="If set, regions that are not overlapped by any file will also be reported. Requires a valid organism key for all input datasets" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
97
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
98 </inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
99
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
100 <outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
101 <data format="tabular" name="output" metadata_source="input1" label="Common intervals identified from among ${input1.name}, ${input2.name} and so on." />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
102 </outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
103 <help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
104
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
105 **What it does**
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
106
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
107 This tool identifies common intervals among multiple, sorted BED files. Intervals can be common among 0 to N of the N input BED files. The pictorial and raw data examples below illustrate the behavior of this tool more clearly.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
108
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
109
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
110 .. image:: http://people.virginia.edu/~arq5x/files/bedtools-galaxy/mbi.png
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
111
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
112
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
113 .. class:: warningmark
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
114
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
115 This tool requires that each BED file is reference-sorted (chrom, then start).
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
116
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
117
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
118 .. class:: infomark
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
119
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
120 The output file will contain five fixed columns, plus additional columns for each BED file:
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
121
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
122 * 1. Chromosome name (or 'genome' for whole-genome coverage).
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
123 * 2. The zero-based start position of the interval.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
124 * 3. The one-based end position of the interval.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
125 * 4. The number of input files that had at least one feature overlapping this interval.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
126 * 5. A list of input files or labels that had at least one feature overlapping this interval.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
127 * 6. For each input file, an indication (1 = Yes, 0 = No) of whether or not the file had at least one feature overlapping this interval.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
128
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
129 ------
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
130
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
131 **Example input**::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
132
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
133 # a.bed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
134 chr1 6 12
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
135 chr1 10 20
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
136 chr1 22 27
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
137 chr1 24 30
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
138
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
139 # b.bed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
140 chr1 12 32
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
141 chr1 14 30
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
142
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
143 # c.bed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
144 chr1 8 15
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
145 chr1 10 14
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
146 chr1 32 34
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
147
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
148
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
149 ------
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
150
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
151 **Example without a header and without reporting intervals with zero coverage**::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
152
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
153
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
154 chr1 6 8 1 1 1 0 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
155 chr1 8 12 2 1,3 1 0 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
156 chr1 12 15 3 1,2,3 1 1 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
157 chr1 15 20 2 1,2 1 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
158 chr1 20 22 1 2 0 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
159 chr1 22 30 2 1,2 1 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
160 chr1 30 32 1 2 0 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
161 chr1 32 34 1 3 0 0 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
162
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
163
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
164 **Example adding a header line**::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
165
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
166
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
167 chrom start end num list a.bed b.bed c.bed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
168 chr1 6 8 1 1 1 0 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
169 chr1 8 12 2 1,3 1 0 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
170 chr1 12 15 3 1,2,3 1 1 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
171 chr1 15 20 2 1,2 1 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
172 chr1 20 22 1 2 0 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
173 chr1 22 30 2 1,2 1 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
174 chr1 30 32 1 2 0 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
175 chr1 32 34 1 3 0 0 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
176
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
177
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
178 **Example adding a header line and custom file labels**::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
179
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
180
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
181 chrom start end num list joe bob sue
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
182 chr1 6 8 1 joe 1 0 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
183 chr1 8 12 2 joe,sue 1 0 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
184 chr1 12 15 3 joe,bob,sue 1 1 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
185 chr1 15 20 2 joe,bob 1 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
186 chr1 20 22 1 bob 0 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
187 chr1 22 30 2 joe,bob 1 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
188 chr1 30 32 1 bob 0 1 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
189 chr1 32 34 1 sue 0 0 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
190
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
191
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
192 @REFERENCES@
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
193
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
194 </help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
195 </tool>