annotate subtractBed.xml @ 45:b176b1c7949e draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 69394918e7a50dad3ae578e932cbac27b96e0d3b
author iuc
date Tue, 24 Jul 2018 11:49:34 -0400
parents d279800f4ff9
children 2f457890d8c8
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_subtractbed" name="SubtractBed" version="@WRAPPER_VERSION@.0">
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>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 bedtools subtract
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
11 $strand
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
12 -a '$inputA'
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
13 -b '$inputB'
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 -f $overlap
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 $removeIfOverlap
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 17
diff changeset
16 > '$output'
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 <inputs>
42
d279800f4ff9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b75b9e79cf3186a22dc2e1e9d27c1a080b891b59
iuc
parents: 26
diff changeset
20 <param format="@STD_BEDTOOLS_INPUTS@" name="inputA" type="data" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
d279800f4ff9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b75b9e79cf3186a22dc2e1e9d27c1a080b891b59
iuc
parents: 26
diff changeset
21 <param format="@STD_BEDTOOLS_INPUTS@" name="inputB" type="data" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 <expand macro="strand2" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <expand macro="overlap" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <param name="removeIfOverlap" type="select" label="Calculation based on strandedness?">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <option value="" selected="True">Dont Remove entire feature on overlap</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <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</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 <option value="-N">Same as -A except when used with -f, the amount is the sum of all features (not any single feature)</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <data format_source="inputA" name="output" metadata_source="inputA"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <output name="output" file="subtractBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <param name="overlap" value="0.80" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <output name="output" file="subtractBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 <param name="inputA" value="subtractBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <param name="inputB" value="subtractBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 <param name="removeIfOverlap" value="-A" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 <output name="output" file="subtractBed_result3.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 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
57
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 .. image:: $PATH_TO_IMAGES/subtract-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 </tool>