annotate subtractBed.xml @ 41:7ab85ac5f64b draft

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