Mercurial > repos > iuc > bedtools

annotate jaccardBed.xml @ 64:f6c88d2e9ae5 draft default tip

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 73ebd55430874a3c1483b6dd6cce0482175482f9
author iuc
date Fri, 21 Feb 2025 21:38:34 +0000
parents 539958feb49c
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
57
1d0a0d6a78b1 "planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 1e25e8d0bd1ebeb2b94c4bbdff222e56defc1fc2"
iuc
parents: 56
diff changeset
1 <tool id="bedtools_jaccard" name="bedtools JaccardBed" version="@TOOL_VERSION@" profile="@PROFILE@">
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>
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>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
6 <expand macro="bio_tools"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
7 <expand macro="requirements"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
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"/>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
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"/>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
27 <expand macro="reciprocal"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
28 <param name="strand" argument="-s" type="boolean" truevalue="-s" falsevalue="" checked="false" label="Force strandedness" help="That is, only report hits in B that overlap A on the same strand. By default, overlaps are reported without respect to strand."/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
29 <expand macro="split"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <outputs>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
32 <data name="output" format_source="inputA" metadata_source="inputA" label="Intersection of ${inputA.name} and ${inputB.name}"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 <test>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
36 <param name="inputA" value="jaccardBed1.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
37 <param name="inputB" value="jaccardBed2.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
38 <output name="output" file="jaccardBed_result1.bed" ftype="bed"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <test>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
41 <param name="inputA" value="jaccardBed1.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
42 <param name="inputB" value="jaccardBed2.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
43 <param name="overlap" value="0.1"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
44 <output name="output" file="jaccardBed_result2.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
45 </test>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
46 <test>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
47 <param name="inputA" value="jaccardBed1.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
48 <param name="inputB" value="jaccardBed2.bed" ftype="bed"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
49 <param name="overlap" value="0.1"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
50 <param name="strand" value="true"/>
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
51 <output name="output" file="jaccardBed_strand_result2.bed" ftype="bed"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 </tests>
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
54 <help><![CDATA[
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 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
58 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
59
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 .. image:: $PATH_TO_IMAGES/jaccard-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 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
65
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 @REFERENCES@
50
df28283b3778 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents: 48
diff changeset
67 ]]></help>
64
f6c88d2e9ae5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 73ebd55430874a3c1483b6dd6cce0482175482f9
iuc
parents: 59
diff changeset
68 <expand macro="citations"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </tool>