Mercurial > repos > iuc > bedtools
annotate coverageBed.xml @ 19:a8eabd2838f6 draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
author | iuc |
---|---|
date | Fri, 08 Dec 2017 03:26:42 -0500 |
parents | 18aeac3cd1db |
children | df56e1b12d0c |
rev | line source |
---|---|
19
a8eabd2838f6
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 542ddc9e98cee5cc2a9e4caae945dee4b2c747b8
iuc
parents:
18
diff
changeset
|
1 <tool id="bedtools_coveragebed" name="Compute both the depth and breadth of coverage" version="@WRAPPER_VERSION@.0"> |
9
2ab422b551df
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit bad476ff5076338f3eebdf0c25bb5a6c745e5592
iuc
parents:
8
diff
changeset
|
2 <description>of features in file B on the features in file A (bedtools coverage)</description> |
0 | 3 <macros> |
4 <import>macros.xml</import> | |
5 </macros> | |
6 <expand macro="requirements" /> | |
7 <expand macro="stdio" /> | |
8 <command> | |
1 | 9 <![CDATA[ |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
10 #set inputBs = "' '".join([str($file) for $file in $inputB]) |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
11 |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
12 bedtools coverage |
0 | 13 $d |
14 $hist | |
15 $split | |
16 $strandedness | |
18
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
17 #if str($overlap_a) != "None" and str($overlap_a): |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
18 -f '$overlap_a' |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
19 #end if |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
20 #if str($overlap_b) != "None" and str($overlap_b): |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
21 -F '$overlap_b' |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
22 #end if |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
23 $reciprocal_overlap |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
24 $a_or_b |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
25 -a '$inputA' |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
26 -b '$inputBs' |
0 | 27 | sort -k1,1 -k2,2n |
1 | 28 > '$output' |
29 ]]> | |
0 | 30 </command> |
31 <inputs> | |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
32 <param format="bam,bed,gff,gff3,vcf" name="inputA" type="data" label="File A (on which coverage is calculated)" help="BAM/BED/GFF/VCF format" /> |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
33 <param format="bam,bed,gff,gff3,vcf" name="inputB" type="data" multiple="true" label="File(s) B (for which coverage is calculated)" help="BAM/BED/GFF/VCF format" /> |
1 | 34 <expand macro="split" /> |
11
7308cc546a36
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents:
9
diff
changeset
|
35 <param name="strandedness" type="boolean" label="Force strandedness" truevalue="-s" falsevalue="" checked="false" |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
36 help="Only report hits in B that overlap A on the same strand. By default, overlaps are reported without respect to strand (-s)"/> |
1 | 37 <param name="d" type="boolean" checked="false" truevalue="-d" falsevalue="" |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
38 label="Report the depth at each position in each A feature" |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
39 help="Positions reported are one based. Each position and depth follow the complete B feature (-d)" /> |
1 | 40 <param name="hist" type="boolean" checked="false" truevalue="-hist" falsevalue="" |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
41 label="Report a histogram of coverage for each feature in A as well as a summary histogram for all features in A" |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
42 help="Additional columns after each feature in A: 1) depth 2) # bases at depth 3) size of A 4) % of A at depth (-hist)" /> |
18
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
43 <param name="overlap_a" type="text" |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
44 label="Minimum overlap required as a fraction of A." |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
45 help="Default is 1E-9 (i.e., 1bp). (-f)"> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
46 <sanitizer invalid_char=""> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
47 <valid initial="string.digits"><add value=",."/></valid> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
48 </sanitizer> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
49 </param> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
50 <param name="overlap_b" type="text" |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
51 label="Minimum overlap required as a fraction of B." |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
52 help="Default is 1E-9 (i.e., 1bp). (-F)"> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
53 <sanitizer invalid_char=""> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
54 <valid initial="string.digits"><add value=",."/></valid> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
55 </sanitizer> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
56 </param> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
57 <param name="reciprocal_overlap" type="boolean" checked="false" truevalue="-r" falsevalue="" |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
58 label="Require that the fraction overlap be reciprocal for A AND B." |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
59 help="if -f is 0.90 and -r is used, this requires that B overlap 90% of A and A _also_ overlaps 90% of B (-r)" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
60 <param name="a_or_b" type="boolean" checked="false" truevalue="-e" falsevalue="" |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
61 label="Require that the minimum fraction be satisfied for A OR B." |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
62 help="if -e is used with -f 0.90 and -F 0.10 this requires that either 90% of A is covered OR 10% of B is covered. Without -e, both fractions would have to be satisfied. (-e)" /> |
0 | 63 </inputs> |
64 <outputs> | |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
65 <data format="bed" name="output" metadata_source="inputA" label="Count of overlaps on ${inputA.name}"/> |
0 | 66 </outputs> |
1 | 67 <tests> |
68 <test> | |
69 <param name="inputA" value="coverageBedA.bed" ftype="bed" /> | |
18
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
70 <param name="inputB" value="coverageBedB.bed" ftype="bed" /> |
1 | 71 <output name="output" file="coverageBed_result1.bed" ftype="bed" /> |
72 </test> | |
18
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
73 <test> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
74 <param name="inputA" value="coverageBedA.bed" ftype="bed" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
75 <param name="inputB" value="coverageBedB.bed" ftype="bed" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
76 <param name="overlap_b" value="1" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
77 <output name="output" file="coverageBed_result2_F1.bed" ftype="bed" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
78 </test> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
79 <test> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
80 <param name="inputA" value="coverageBedA.bed" ftype="bed" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
81 <param name="inputB" value="coverageBedB.bed" ftype="bed" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
82 <param name="overlap_a" value="1" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
83 <param name="reciprocal_overlap" value="true" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
84 <output name="output" file="coverageBed_result3_f1r.bed" ftype="bed" /> |
18aeac3cd1db
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit dc0d10f28180ec2b2d1b0beac637601ea859e8f2
iuc
parents:
11
diff
changeset
|
85 </test> |
1 | 86 </tests> |
0 | 87 <help> |
1 | 88 <![CDATA[ |
0 | 89 **What it does** |
90 | |
11
7308cc546a36
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents:
9
diff
changeset
|
91 `bedtools coverage`_ computes both the *depth* and *breadth* of coverage of features in |
7308cc546a36
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents:
9
diff
changeset
|
92 file B on the features in file A. For example, ``bedtools coverage`` can compute the coverage of sequence alignments |
7308cc546a36
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents:
9
diff
changeset
|
93 (file B) across 1 kilobase (arbitrary) windows (file A) tiling a genome of interest. |
7308cc546a36
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents:
9
diff
changeset
|
94 One advantage that ``bedtools coverage`` offers is that it not only *counts* the number of features that |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
95 overlap an interval in file A, it also computes the fraction of bases in the interval in A that were overlapped by one or more features. |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
96 Thus, ``bedtools coverage`` also computes the *breadth* of coverage for each interval in A. |
0 | 97 |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
98 .. _bedtools coverage: http://bedtools.readthedocs.org/en/latest/content/tools/coverage.html |
0 | 99 |
100 .. class:: infomark | |
101 | |
6
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
102 The lines in the output will be comprised of each interval in A, followed by: |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
103 |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
104 1. The number of features in B that overlapped (by at least one base pair) the A interval. |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
105 2. The number of bases in A that had non-zero coverage from features in B. |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
106 3. The length of the entry in A. |
d25966c8ddeb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f-dirty
iuc
parents:
1
diff
changeset
|
107 4. The fraction of bases in A that had non-zero coverage from features in B. |
0 | 108 |
109 @REFERENCES@ | |
1 | 110 ]]> |
0 | 111 </help> |
112 <expand macro="citations" /> | |
113 </tool> |