annotate closestBed.xml @ 0:b8348686a0b9 draft

Imported from capsule None
author iuc
date Tue, 04 Nov 2014 01:45:04 -0500
parents
children 82aac94b06c3
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_closestbed" name="ClosestBed" version="@WRAPPER_VERSION@.0">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
2 <description></description>
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>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
9 closestBed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 $strand
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 $addition
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 -t $ties
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 -a $inputA
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 -b $inputB
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 &gt; $output
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="overlap intervals in this BED/VCF/GFF file?"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 <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.">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 <option value="all" selected="True">all - Report all ties (default)</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 <option value="first">first - Report the first tie that occurred in the B file</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 <option value="last">last - Report the last tie that occurred in the B file</option>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 </param>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 <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" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 <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" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 <data format_source="inputA" name="output" metadata_source="inputA" label="Intersection of ${inputA.name} and ${inputB.name}"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 </outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 </tool>