Mercurial > repos > bgruening > bedtools_test_bag

annotate subtractBed.xml @ 6:75d323631dce draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
Uploaded
author bernhardlutz
date Wed, 18 Jun 2014 12:40:28 -0400
parents
children c782e0edc4f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
6
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="bedtools_subtractbed" name="SubtractBed" version="0.2.0">
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
9 bedtools subtract
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
10 $strand
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
11 -a $inputA
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
12 -b $inputB
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
13 -f $overlap
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
14 $removeIfOverlap
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
15 &gt; $output
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
16 </command>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
17 <inputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
18 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
19 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
20 <expand macro="strand2" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
21 <expand macro="overlap" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
22
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
23 <param name="strand" type="select" label="Calculation based on strandedness?">
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
24 <option value="" selected="True">Overlaps on either strand</option>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
25 <option value="-s">Only overlaps occurring on the **same** strand.</option>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
26 <option value="-S">Only overlaps occurring on the **opposite** strand.</option>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
27 </param>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
28
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
29 <param name="removeIfOverlap" type="select" label="Calculation based on strandedness?">
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
30 <option value="" selected="True">Dont Remove entire feature on overlap</option>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
31 <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>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
32 <option value="-N">Same as -A except when used with -f, the amount is the sum of all features (not any single feature).</option>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
33 </param>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
34 </inputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
35 <outputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
36 <data format_source="inputA" name="output" metadata_source="inputA" label=""/>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
37 </outputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
38 <help>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
39
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
40 **What it does**
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
41
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
42 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.
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
43
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
44 .. image:: $PATH_TO_IMAGES/subtract-glyph.png
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
45 @REFERENCES@
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
46 </help>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
47 </tool>