annotate reldist.xml @ 36:1133660b0f9d draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 9f7b029951fa0f854c9c6a5f241ce9a20ae4f22a
author iuc
date Wed, 10 Jan 2018 19:21:14 -0500
parents ac2040a5e6ff
children d279800f4ff9
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_reldistbed" name="ReldistBed" version="@WRAPPER_VERSION@.0">
17
a2d4c30ba2f9 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 0887009a23d176b21536c9fd8a18c4fecc417d4f
iuc
parents: 8
diff changeset
2 <description>calculate the distribution of relative distances</description>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 bedtools reldist
28
f0aca67fdb71 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 391d2d41095edb2badf70924d3636238453ee377
iuc
parents: 17
diff changeset
11 -a '$inputA'
f0aca67fdb71 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 391d2d41095edb2badf70924d3636238453ee377
iuc
parents: 17
diff changeset
12 -b '$inputB'
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 $detail
28
f0aca67fdb71 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 391d2d41095edb2badf70924d3636238453ee377
iuc
parents: 17
diff changeset
14 > '$output'
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 <inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 <param format="bed,bam,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF/BAM file"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 <param format="bed,gff,vcf,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 <param name="detail" type="boolean" checked="false" truevalue="-detail" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 label="Instead of a summary, report the relative distance for each interval in A" help="(-detail)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <data format_source="inputA" name="output" metadata_source="inputA" label="Relalative distance of ${inputA.name} and ${inputB.name}"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 <test>
35
ac2040a5e6ff planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
iuc
parents: 28
diff changeset
28 <param name="inputA" value="a.bed" ftype="bed" />
ac2040a5e6ff planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
iuc
parents: 28
diff changeset
29 <param name="inputB" value="a.bed" ftype="bed" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 <output name="output" file="reldistBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36
0d3aa592ce27 Uploaded
iuc
parents:
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).
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 .. image:: $PATH_TO_IMAGES/reldist-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 <expand macro="citations">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <citation type="doi">10.1371/journal.pcbi.1002529</citation>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 </expand>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 </tool>