annotate reldist.xml @ 51:b4cf5fca8773 draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e2a10eeee8765ba6cf03847562e56cdaeaf4ba5c"
author iuc
date Thu, 05 Sep 2019 19:34:55 -0400
parents df28283b3778
children 7a06bb42dbb1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
1 <tool id="bedtools_reldistbed" name="bedtools ReldistBed" version="@TOOL_VERSION@">
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" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
8 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
9 bedtools reldist
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 -a '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 -b '$inputB'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 $detail
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 <param name="inputA" argument="-a" type="data" format="bam,@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@/BAM file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 <param name="inputB" argument="-b" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
18 <param argument="-detail" type="boolean" truevalue="-detail" falsevalue="" checked="false"
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 label="Instead of a summary, report the relative distance for each interval in A" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
22 <data name="output" format_source="inputA" metadata_source="inputA" label="Relalative distance of ${inputA.name} and ${inputB.name}"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <test>
35
ac2040a5e6ff planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
iuc
parents: 28
diff changeset
26 <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
27 <param name="inputB" value="a.bed" ftype="bed" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 <output name="output" file="reldistBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
31 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 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
35
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 .. image:: $PATH_TO_IMAGES/reldist-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
41 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <expand macro="citations">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <citation type="doi">10.1371/journal.pcbi.1002529</citation>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 </expand>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 </tool>