annotate reldist.xml @ 1:82aac94b06c3 draft

Uploaded
author iuc
date Thu, 08 Jan 2015 14:25:51 -0500
parents b8348686a0b9
children 607c0576c6ab
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_reldistbed" name="ReldistBed" 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>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
9 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 bedtools reldist
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 -a $inputA
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 -b $inputB
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 $detail
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
14 > "$output"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
15 ]]>
0
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,bam,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF/BAM file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
20 <param name="detail" type="boolean" checked="false" truevalue="-detail" falsevalue=""
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
21 label="Instead of a summary, report the relative distance for each interval in A" help="(-detail)" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 <outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
24 <data format_source="inputA" name="output" metadata_source="inputA" label="Relalative distance of ${inputA.name} and ${inputB.name}"/>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
26 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
27 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
28 <param name="inputA" value="windowBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 <param name="inputB" value="windowBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
30 <output name="output" file="reldistBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
31 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
32 </tests>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <help>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
34 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 Traditional approaches to summarizing the similarity between two sets of genomic intervals are based upon the number or proportion of intersecting intervals. However, such measures are largely blind to spatial correlations between the two sets where, dpesite consistent spacing or proximity, intersections are rare (for example, enhancers and transcription start sites rarely overlap, yet they are much closer to one another than two sets of random intervals). Favorov et al proposed a relative distance metric that describes distribution of relative distances between each interval in one set nd the two closest intervals in another set (see figure above). If there is no spatial correlation between the two sets, one would expect the relative distances to be uniformaly distributed among the relative distances ranging from 0 to 0.5. If, however, the intervals tend to be much closer than expected by chance, the distribution of observed relative distances would be shifted towards low relative distance values (e.g., the figure below).
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 .. image:: $PATH_TO_IMAGES/reldist-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43 @REFERENCES@
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
44 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45 </help>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 <expand macro="citations">
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
47 <citation type="doi">10.1371/journal.pcbi.1002529</citation>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
48 </expand>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
49 </tool>