annotate jaccardBed.xml @ 17:44867b59dbf2 draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit cf7a3674bc833bbd5fdd2ad02e724935ffc7a174
author iuc
date Tue, 05 Sep 2017 15:40:14 -0400
parents 7308cc546a36
children 95a3b2c25bd1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
1 <tool id="bedtools_jaccard" name="JaccardBed" version="@WRAPPER_VERSION@.0">
4
607c0576c6ab planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 1
diff changeset
2 <description>calculate the distribution of relative distances between two files</description>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
3 <macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
4 <import>macros.xml</import>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
5 </macros>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
6 <expand macro="requirements" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
7 <expand macro="stdio" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
8 <command>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
9 <![CDATA[
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 bedtools jaccard
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
11 $strand
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
12 $split
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
13 $reciprocal
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
14 -f $overlap
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
15 -a '$inputA'
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
16 -b '$inputB'
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
17 > '$output'
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
18 ]]>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 <param format="bed,vcf,gff,gff3" name="inputA" type="data" label="BED/VCF/GFF file"/>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 <param format="bed,vcf,gff,gff3" name="inputB" type="data" label="BED/VCF/GFF file"/>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
23 <expand macro="overlap" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
24 <expand macro="reciprocal" />
11
7308cc546a36 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 4
diff changeset
25 <param name="strand" type="boolean" checked="false" truevalue="-s" falsevalue=""
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
26 label="Force strandedness"
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
27 help="That is, only report hits in B that overlap A on the same strand. By default, overlaps are reported without respect to strand. (-s)" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 <expand macro="strand2" />
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
29 <expand macro="split" />
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <data format_source="inputA" name="output" metadata_source="inputA" label="Intersection of ${inputA.name} and ${inputB.name}" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 </outputs>
1
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
34 <tests>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
35 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
36 <param name="inputA" value="jaccardBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
37 <param name="inputB" value="jaccardBed2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
38 <output name="output" file="jaccardBed_result1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
39 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
40 <test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
41 <param name="inputA" value="jaccardBed1.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
42 <param name="inputB" value="jaccardBed2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
43 <param name="overlap" value="0.1" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
44 <output name="output" file="jaccardBed_result2.bed" ftype="bed" />
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
45 </test>
82aac94b06c3 Uploaded
iuc
parents: 0
diff changeset
46 </tests>
0
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
47 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
48
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
49 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
52 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.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
54 .. image:: $PATH_TO_IMAGES/jaccard-glyph.png
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56 .. class:: warningmark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 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).
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
59
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
60 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
61 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
62 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
63 </tool>