annotate subtractBed.xml @ 64:f6c88d2e9ae5 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
author iuc
date Fri, 21 Feb 2025 21:38:34 +0000
parents 539958feb49c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
1d0a0d6a78b1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 56
diff changeset
1 <tool id="bedtools_subtractbed" name="bedtools SubtractBed" version="@TOOL_VERSION@" profile="@PROFILE@">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 8
diff changeset
2 <description>remove intervals based on overlaps</description>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
59
539958feb49c "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 500a03281ea704abc7a16d9af63d67dbdcc5cd0b"
iuc
parents: 57
diff changeset
6 <expand macro="bio_tools" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <expand macro="stdio" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 bedtools subtract
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 $strand
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 -a '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 -b '$inputB'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 @OVERLAP@
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
15 $removeIfOverlap
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 <param name="inputA" argument="-a" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
20 <param name="inputB" argument="-b" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 <expand macro="strand2" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 <expand macro="overlap" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <param name="removeIfOverlap" type="select" label="Calculation based on strandedness?">
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
24 <option value="" selected="true">Don't Remove entire feature on overlap</option>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
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>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
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>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
30 <data name="output" format_source="inputA" metadata_source="inputA"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <output name="output" file="subtractBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <param name="overlap" value="0.80" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <output name="output" file="subtractBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <param name="removeIfOverlap" value="-A" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 <output name="output" file="subtractBed_result3.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
51 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 bedtools 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.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 .. image:: $PATH_TO_IMAGES/subtract-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
59 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 </tool>