annotate multiIntersectBed.xml @ 16:e0cec48a4695 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit ea1ac33f3337ac44f43150f585c9ccd38e08da0c
author iuc
date Fri, 18 Aug 2017 15:33:08 -0400
parents 7308cc546a36
children 44867b59dbf2
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
1 <tool id="bedtools_multiintersectbed" name="Multiple Intersect" version="@WRAPPER_VERSION@.0">
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
2 <description>identifies common intervals among multiple interval files</description>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
9 <![CDATA[
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
10 bedtools multiinter
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 $header
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
12 $cluster
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
13 -filler "${filler}"
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 #if $zero.value == True:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 -empty
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
16 -g $genome
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
19 #if str($tag.tag_select) == "tag":
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
20 #set files = '" "'.join( [ str( $file ) for $file in $tag.inputs ] )
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
21 -i "${files}"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
22 #else:
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
23 -i
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
24 #for $file in $tag.beds:
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
25 "${file.input}"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
26 #end for
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
27 -names
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
28 #for $file in $tag.beds:
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 "{$file.custom_name}"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
30 #end for
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 #end if
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
33 > '$output'
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
34 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 <inputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 <conditional name="tag">
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
38 <param name="tag_select" type="select" label="Sample name">
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 <option value="tag" selected="true">Use input's tag</option>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <option value="custom">Enter custom name per file</option>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 </param>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 <when value="tag">
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <param name="inputs" format="bed" type="data" multiple="True" label="BED files" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 </when>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45 <when value="custom">
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 <repeat name="beds" title="Add BED files" min="2" >
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 <param name="input" format="bed" type="data" multiple="True" label="BED file" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 <param name="custom_name" type="text" area="false" label="Custom sample name"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
49 </repeat>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50 </when>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51 </conditional>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
52 <expand macro="genome" />
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
53 <param name="cluster" type="boolean" checked="false" truevalue="-cluster" falsevalue=""
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
54 label="Invoke Ryan Layers's clustering algorithm"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
55 help="(-cluster)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
56 <param name="zero" type="boolean" checked="true"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
57 label="Report regions that are not covered by any of the files"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
58 help="If set, regions that are not overlapped by any file will also be reported. Requires a valid organism key for all input datasets" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
59 <param name="filler" type="text" value="N/A"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
60 label="Text to use for no-coverage value"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
61 help="Can be 0.0, N/A, - or any other value. (-filler)" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
62 <expand macro="print_header" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
64 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
65 <outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
66 <data format="bed" name="output" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
67 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
68 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
69 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
70 <param name="tag_select" value="tag"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
71 <param name="inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed,multiIntersectBed3.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
72 <param name="zero" value="False"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
73 <output name="output" file="multiIntersectBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
74 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
75 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
76 <param name="tag_select" value="tag"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
77 <param name="inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed,multiIntersectBed3.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
78 <param name="header" value="True"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
79 <param name="zero" value="False"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
80 <output name="output" file="multiIntersectBed_result2.bed" lines_diff="2" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
81 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
82 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
83 <param name="tag_select" value="tag"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
84 <param name="inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed,multiIntersectBed3.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
85 <param name="zero" value="True"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
86 <param name="genome" value="multiIntersectBed1.len"/>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
87 <output name="output" file="multiIntersectBed_result3.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
88 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
89 </tests>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
90 <help>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
91 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
92 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
93
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
94 This tool identifies common intervals among multiple, sorted BED files. Intervals can be common among 0 to N of the N input BED files.
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
95
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
96
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
97 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
98
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
99 This tool requires that each BED file is reference-sorted (chrom, then start).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
100
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
101
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
102 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
103
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
104 The output file will contain five fixed columns, plus additional columns for each BED file:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
105
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
106 * 1. Chromosome name (or 'genome' for whole-genome coverage).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
107 * 2. The zero-based start position of the interval.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
108 * 3. The one-based end position of the interval.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
109 * 4. The number of input files that had at least one feature overlapping this interval.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
110 * 5. A list of input files or labels that had at least one feature overlapping this interval.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
111 * 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
112
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
113 ------
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
114
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
115 **Example input**::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
116
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
117 # a.bed
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
118 chr1 6 12bed
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
119 chr1 10 20
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
120 chr1 22 27
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
121 chr1 24 30
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
122
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
123 # b.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
124 chr1 12 32
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
125 chr1 14 30
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
126
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
127 # c.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
128 chr1 8 15
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
129 chr1 10 14
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
130 chr1 32 34
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
131
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
132
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
133 ------
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
134
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
135 **Example without a header and without reporting intervals with zero coverage**::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
136
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
137
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
138 chr1 6 8 1 1 1 0 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
139 chr1 8 12 2 1,3 1 0 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
140 chr1 12 15 3 1,2,3 1 1 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
141 chr1 15 20 2 1,2 1 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
142 chr1 20 22 1 2 0 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
143 chr1 22 30 2 1,2 1 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
144 chr1 30 32 1 2 0 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
145 chr1 32 34 1 3 0 0 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
146
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
147
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
148 **Example adding a header line**::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
149
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
150
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
151 chrom start end num list a.bed b.bed c.bed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
152 chr1 6 8 1 1 1 0 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
153 chr1 8 12 2 1,3 1 0 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
154 chr1 12 15 3 1,2,3 1 1 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
155 chr1 15 20 2 1,2 1 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
156 chr1 20 22 1 2 0 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
157 chr1 22 30 2 1,2 1 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
158 chr1 30 32 1 2 0 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
159 chr1 32 34 1 3 0 0 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
160
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
161
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
162 **Example adding a header line and custom file labels**::
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
163
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
164
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
165 chrom start end num list joe bob sue
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
166 chr1 6 8 1 joe 1 0 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
167 chr1 8 12 2 joe,sue 1 0 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
168 chr1 12 15 3 joe,bob,sue 1 1 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
169 chr1 15 20 2 joe,bob 1 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
170 chr1 20 22 1 bob 0 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
171 chr1 22 30 2 joe,bob 1 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
172 chr1 30 32 1 bob 0 1 0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
173 chr1 32 34 1 sue 0 0 1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
174
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
175
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
176 @REFERENCES@
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
177 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
178 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
179 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
180 </tool>