annotate reldist.xml @ 0:4fb5ea02b441 draft

Uploaded
author iuc
date Tue, 15 Jul 2014 14:42:23 -0400
parents
children 7511823bdea1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_reldistbed" name="ReldistBed" version="@WRAPPER_VERSION@.0">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
2 <description></description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
3 <macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
5 </macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
8 <command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
9 bedtools reldist
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
10 -a $inputA
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
11 -b $inputB
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
12 $detail
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
13 </command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
14 <inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
15 <param format="bed,bam,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF/BAM file"/>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
16 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
4fb5ea02b441 Uploaded
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="" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
18 </inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
19 <outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
20 <data format_source="inputA" name="output" metadata_source="inputA" label="Intersection of ${inputA.name} and ${inputB.name}"/>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
21 </outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
22 <help>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
23
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
24 **What it does**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
25
4fb5ea02b441 Uploaded
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).
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
27
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
28 .. image:: $PATH_TO_IMAGES/reldist-glyph.png
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
29
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
30 .. class:: infomark
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
31
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
32 @REFERENCES@
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
33
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
34 </help>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
35 </tool>