annotate reldist.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_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>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
9 bedtools reldist
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 -a $inputA
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 -b $inputB
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 $detail
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 <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
16 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 <param name="detail" type="boolean" checked="false" truevalue="-detail" falsevalue="" label="Instead of a summary, report the relative distance for each interval in A" help="" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20 <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
21 </outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 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 [1] 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).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 .. image:: $PATH_TO_IMAGES/reldist-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 </tool>