Mercurial > repos > iuc > bedtools

annotate jaccardBed.xml @ 56:7a06bb42dbb1 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
author iuc
date Tue, 31 Aug 2021 07:45:56 +0000
parents 9a9f1a7abf54
children 1d0a0d6a78b1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
52
9a9f1a7abf54 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit fe3f54a0d3edb83fcf6752e3b1524c582b4febd5"
iuc
parents: 50
diff changeset
1 <tool id="bedtools_jaccard" name="bedtools JaccardBed" 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 between two files</description>
56
7a06bb42dbb1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit e0d4688a59e6eeba33adcfe803ac43d0bc2863e7"
iuc
parents: 52
diff changeset
3 <expand macro="bio_tools" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <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
9 <command><![CDATA[
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
10 bedtools jaccard
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
11 $strand
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
12 $split
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
13 $reciprocal
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
14 @OVERLAP@
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
15 #if str($overlapB):
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
16 -F $overlapB
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
17 #end if
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
18 -a '$inputA'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
19 -b '$inputB'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
20 > '$output'
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
21 ]]></command>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 <inputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
23 <param name="inputA" argument="-a" 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
24 <param name="inputB" argument="-b" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <expand macro="overlap" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
26 <expand macro="overlap" name="overlapB" argument="-F" fracof="B"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 <expand macro="reciprocal" />
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
28 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false"
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 label="Force strandedness"
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
30 help="That is, only report hits in B that overlap A on the same strand. By default, overlaps are reported without respect to strand." />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <expand macro="strand2" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <expand macro="split" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <outputs>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
35 <data name="output" format_source="inputA" metadata_source="inputA" label="Intersection of ${inputA.name} and ${inputB.name}" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <param name="inputA" value="jaccardBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <param name="inputB" value="jaccardBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <output name="output" file="jaccardBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <param name="inputA" value="jaccardBed1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 <param name="inputB" value="jaccardBed2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 <param name="overlap" value="0.1" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <output name="output" file="jaccardBed_result2.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
50 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 By default, bedtools jaccard reports the length of the intersection, the length of the union (minus the intersection), the final Jaccard statistic reflecting the similarity of the two sets, as well as the number of intersections.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 Whereas the bedtools intersect tool enumerates each an every intersection between two sets of genomic intervals, one often needs a single statistic reflecting the similarity of the two sets based on the intersections between them. The Jaccard statistic is used in set theory to represent the ratio of the intersection of two sets to the union of the two sets. Similarly, Favorov et al [1] reported the use of the Jaccard statistic for genome intervals: specifically, it measures the ratio of the number of intersecting base pairs between two sets to the number of base pairs in the union of the two sets. The bedtools jaccard tool implements this statistic, yet modifies the statistic such that the length of the intersection is subtracted from the length of the union. As a result, the final statistic ranges from 0.0 to 1.0, where 0.0 represents no overlap and 1.0 represent complete overlap.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 .. image:: $PATH_TO_IMAGES/jaccard-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 The jaccard tool requires that your data is pre-sorted by chromosome and then by start position (e.g., sort -k1,1 -k2,2n in.bed > in.sorted.bed for BED files).
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
63 ]]></help>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 </tool>