upstream-extended/iuc/tools/bedtools/subtractBed.xml
1<tool id="bedtools_subtractbed" name="bedtools SubtractBed" version="@TOOL_VERSION@" profile="@PROFILE@">
2 <description>remove intervals based on overlaps</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 subtract
11$strand
12-a '$inputA'
13-b '$inputB'
14@OVERLAP@
15$removeIfOverlap
16> '$output'
17 ]]></command>
18 <inputs>
19 <param name="inputA" argument="-a" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
20 <param name="inputB" argument="-b" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
21 <expand macro="strand2" />
22 <expand macro="overlap" />
23 <param name="removeIfOverlap" type="select" label="Calculation based on strandedness?">
24 <option value="" selected="true">Don't Remove entire feature on overlap</option>
25 <option value="-A">Remove entire feature if any overlap. That is, by default, only subtract the portion of A that overlaps B. Here, if any overlap is found (or -f amount), the entire feature is removed (-A)</option>
26 <option value="-N">Same as -A except when used with -f, the amount is the sum of all features (not any single feature) (-N)</option>
27 </param>
28 </inputs>
29 <outputs>
30 <data name="output" format_source="inputA" metadata_source="inputA"/>
31 </outputs>
32 <tests>
33 <test>
34 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
35 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
36 <output name="output" file="subtractBed_result1.bed" ftype="bed" />
37 </test>
38 <test>
39 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
40 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
41 <param name="overlap" value="0.80" />
42 <output name="output" file="subtractBed_result2.bed" ftype="bed" />
43 </test>
44 <test>
45 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
46 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
47 <param name="removeIfOverlap" value="-A" />
48 <output name="output" file="subtractBed_result3.bed" ftype="bed" />
49 </test>
50 </tests>
51 <help><![CDATA[
52**What it does**
53
54bedtools subtract searches for features in B that overlap A. If an overlapping feature is found in B, the overlapping portion is removed from A and the remaining portion of A is reported. If a feature in B overlaps all of a feature in A, the A feature will not be reported.
55
56.. image:: $PATH_TO_IMAGES/subtract-glyph.png
57
58@REFERENCES@
59 ]]></help>
60 <expand macro="citations" />
61</tool>