annotate closestBed.xml @ 6:75d323631dce draft

Uploaded
author bernhardlutz
date Wed, 18 Jun 2014 12:40:28 -0400
parents b78d20957e7f
children 893617de95e5
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="bedtools_closestbed" name="ClosestBed" version="0.2.0">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
9 closestBed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
10 $split
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
11 $strand
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
12 $addition
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
13 -t $ties
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
14 -a $inputA
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
15 -b $inputB
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
16 &gt; $output
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
17 </command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
18 <inputs>
6
75d323631dce Uploaded
bernhardlutz
parents: 5
diff changeset
19 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
75d323631dce Uploaded
bernhardlutz
parents: 5
diff changeset
20 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="overlap intervals in this BED/VCF/GFF file?"/>
5
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
21
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
22 <param name="ties" type="select" label="How ties for closest feature should be handled" help="This occurs when two features in B have exactly the same overlap with a feature in A.">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
23 <option value="all" selected="True">all- Report all ties (default)</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
24 <option value="first">first- Report the first tie that occurred in the B file</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
25 <option value="last">last- Report the last tie that occurred in the B file</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
26 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
27
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
28 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue="" label="Force strandedness." help="That is, find the closest feature in B overlaps A on the same strand. By default, this is disabled." />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
29 <param name="addition" type="boolean" checked="false" truevalue="-d" falsevalue="" label="In addition to the closest feature in B, report its distance to A as an extra column. The reported distance for overlapping features will be 0." />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
30 </inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
31 <outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
32 <data format_source="inputA" name="output" metadata_source="inputA" label="Intersection of ${inputA.name} and ${inputB.name}"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
33 </outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
34 <help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
35
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
36 **What it does**
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
37
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
38 Similar to intersectBed, closestBed searches for overlapping features in A and B. In the event that no feature in B overlaps the current feature in A, closestBed will report the closest (that is, least genomic distance from the start or end of A) feature in B. For example, one might want to find which is the closest gene to a significant GWAS polymorphism. Note that closestBed will report an overlapping feature as the closest—that is, it does not restrict to closest non-overlapping feature.
6
75d323631dce Uploaded
bernhardlutz
parents: 5
diff changeset
39 @REFERENCES@
5
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
40 </help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
41 </tool>