Source code

Download source archive ↓

upstream-extended/iuc/tools/bedtools/multiIntersectBed.xml

1<tool id="bedtools_multiintersectbed" name="bedtools Multiple Intersect" version="@TOOL_VERSION@+galaxy0" profile="@PROFILE@">
2    <description>identifies common intervals among multiple interval files</description>
3    <macros>
4        <import>macros.xml</import>
5    </macros>
6    <expand macro="bio_tools" />
7    <expand macro="requirements" />
8    <expand macro="stdio" />
9    <command><![CDATA[
10bedtools multiinter
11$header
12$cluster
13-filler '${filler}'
14$empty.empty_selector
15@GENOME_FILE_UNION@
16
17#if str($tag.tag_select) == "tag":
18    -i
19    #for $file in $tag.inputs
20        '$file'
21    #end for
22#else:
23    -i
24    #for $file in $tag.beds:
25        '${file.input}'
26    #end for
27    -names
28    #for $file in $tag.beds:
29        '{$file.custom_name}'
30    #end for
31#end if
32> '$output'
33    ]]></command>
34    <inputs>
35        <conditional name="tag">
36            <param name="tag_select" type="select" label="Sample name">
37                <option value="tag" selected="true">Use input's tag</option>
38                <option value="custom">Enter custom name per file</option>
39            </param>
40            <when value="tag">
41                <param name="inputs" type="data" format="@STD_BEDTOOLS_INPUTS@" multiple="true" label="@STD_BEDTOOLS_INPUT_LABEL@ files" />
42            </when>
43            <when value="custom">
44                <repeat name="beds" title="Add BED files" min="2" >
45                    <param name="input" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file" />
46                    <param name="custom_name" type="text" area="false" label="Custom sample name" />
47                </repeat>
48            </when>
49        </conditional>
50        <param argument="-cluster" type="boolean" truevalue="-cluster" falsevalue="" checked="false"
51            label="Invoke Ryan Layers's clustering algorithm" />
52        <conditional name="empty">
53            <param name="empty_selector" argument="-empty" type="select" label="Report empty regions" help="Include regions that have zero coverage in all BedGraph datasets">
54                <option value="-empty">Yes</option>
55                <option value="">No</option>
56            </param>
57            <when value="-empty">
58                <expand macro="input_conditional_genome_file" />
59            </when>
60            <when value="" />
61        </conditional>
62        <param argument="-filler" type="text" value="N/A"
63            label="Text to use for no-coverage value"
64            help="Can be 0.0, N/A, - or any other value" />
65        <expand macro="print_header" />
66    </inputs>
67    <outputs>
68        <data name="output" format="bed" />
69    </outputs>
70    <tests>
71        <test>
72            <param name="tag|tag_select" value="tag" />
73            <param name="tag|inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed,multiIntersectBed3.bed" ftype="bed" />
74            <param name="empty|empty_selector" value="" />
75            <output name="output" file="multiIntersectBed_result1.bed" ftype="bed" />
76        </test>
77        <test>
78            <param name="tag|tag_select" value="tag" />
79            <param name="tag|inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed,multiIntersectBed3.bed" ftype="bed" />
80            <param name="header" value="true" />
81            <param name="empty|empty_selector" value="" />
82            <output name="output" file="multiIntersectBed_result2.bed" lines_diff="2" ftype="bed" />
83        </test>
84        <test>
85            <param name="tag|tag_select" value="tag" />
86            <param name="tag|inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed,multiIntersectBed3.bed" ftype="bed" />
87            <param name="empty|empty_selector" value="-empty" />
88            <param name="empty|genome_file_opts|genome_file_opts_selector" value="hist" />
89            <param name="empty|genome_file_opts|genome" value="multiIntersectBed1.len" ftype="tabular" />
90            <output name="output" file="multiIntersectBed_result3.bed" ftype="bed" />
91        </test>
92        <test>
93            <param name="tag|tag_select" value="tag" />
94            <param name="tag|inputs" value="multiIntersectBed1.bed,multiIntersectBed2.bed" ftype="bed" />
95            <param name="empty|empty_selector" value="-empty" />
96            <param name="empty|genome_file_opts|genome_file_opts_selector" value="loc" />
97            <param name="empty|genome_file_opts|genome" value="testid" />
98            <output name="output" file="multiIntersectBed_result4.bed" ftype="bed" />
99        </test>
100    </tests>
101    <help><![CDATA[
102**What it does**
103
104This tool identifies common intervals among multiple, sorted BED files. Intervals can be common among 0 to N of the N input BED files.
105
106
107.. class:: warningmark
108
109This tool requires that each BED file is reference-sorted (chrom, then start).
110
111
112.. class:: infomark
113
114The output file will contain five fixed columns, plus additional columns for each BED file:
115
116    * 1. Chromosome name (or 'genome' for whole-genome coverage).
117    * 2. The zero-based start position of the interval.
118    * 3. The one-based end position of the interval.
119    * 4. The number of input files that had at least one feature overlapping this interval.
120    * 5. A list of input files or labels that had at least one feature overlapping this interval.
121    * 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.
122
123------
124
125**Example input**::
126
127    # a.bed
128    chr1  6   12bed
129    chr1  10  20
130    chr1  22  27
131    chr1  24  30
132
133    # b.bed
134    chr1  12  32
135    chr1  14  30
136
137    # c.bed
138    chr1  8   15
139    chr1  10  14
140    chr1  32  34
141
142
143------
144
145**Example without a header and without reporting intervals with zero coverage**::
146
147
148    chr1	6	8	1	1	1	0	0
149    chr1	8	12	2	1,3	1	0	1
150    chr1	12	15	3	1,2,3	1	1	1
151    chr1	15	20	2	1,2	1	1	0
152    chr1	20	22	1	2	0	1	0
153    chr1	22	30	2	1,2	1	1	0
154    chr1	30	32	1	2	0	1	0
155    chr1	32	34	1	3	0	0	1
156
157
158**Example adding a header line**::
159
160
161    chrom	start	end	num	list	a.bed	b.bed	c.bed
162    chr1	6	8	1	1	1	0	0
163    chr1	8	12	2	1,3	1	0	1
164    chr1	12	15	3	1,2,3	1	1	1
165    chr1	15	20	2	1,2	1	1	0
166    chr1	20	22	1	2	0	1	0
167    chr1	22	30	2	1,2	1	1	0
168    chr1	30	32	1	2	0	1	0
169    chr1	32	34	1	3	0	0	1
170
171
172**Example adding a header line and custom file labels**::
173
174
175    chrom	start	end	num	list	    joe	bob	sue
176    chr1	6	8	1	joe	    1	0	0
177    chr1	8	12	2	joe,sue	    1	0	1
178    chr1	12	15	3	joe,bob,sue 1	1	1
179    chr1	15	20	2	joe,bob	    1	1	0
180    chr1	20	22	1	bob	    0	1	0
181    chr1	22	30	2	joe,bob	    1	1	0
182    chr1	30	32	1	bob	    0	1	0
183    chr1	32	34	1	sue	    0	0	1
184
185
186@REFERENCES@
187    ]]></help>
188    <expand macro="citations" />
189</tool>