Mercurial > repos > iuc > bedtools

annotate genomeCoverageBed.xml @ 32:b0d5e752c0c5 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 a78ca56350b1fcf9d7de2a1112155c9bd0844348
author iuc
date Tue, 05 Sep 2017 09:51:56 -0400
parents c0fbce5dc84a
children ac2040a5e6ff
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
1 <tool id="bedtools_genomecoveragebed" name="Genome Coverage" version="@WRAPPER_VERSION@.1">
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>compute the coverage over an entire genome</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" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 bedtools genomecov
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
11 @GENOME_FILE_COVERAGE@
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
12
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 $split
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 $strand
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 #if str($report.report_select) == "bg":
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 #if $report.zero_regions:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 $report.zero_regions
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 #else:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 -bg
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 #if str($report.scale):
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 -scale $report.scale
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 #else:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 #if str($report.max):
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 -max $report.max
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 $d
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 $dz
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 $five
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 $three
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 > '$output'
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <inputs>
23
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
40 <conditional name="input_type">
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
41 <param name="input_type_select" type="select" label="Input type">
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
42 <option value="bed">BED/VCF/GFF</option>
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
43 <option value="bam">BAM</option>
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
44 </param>
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
45 <when value="bed">
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
46 <param format="bed,vcf,gff,gff3" name="input" type="data" label="BED/VCF/GFF file" />
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
47 <expand macro="input_conditional_genome_file" />
23
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
48 </when>
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
49 <when value="bam">
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
50 <param format="bam" name="input" type="data" label="BAM file" />
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
51 </when>
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
52 </conditional>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 <conditional name="report">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 <param name="report_select" type="select" label="Output type">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 <option value="bg" selected="true">BedGraph coverage file</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 <option value="hist">Data suiteable for Histogram</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58 <when value="bg">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 <param name="zero_regions" type="boolean" checked="False" truevalue="-bga" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60 label="Report regions with zero coverage" help="If set, regions without any coverage will also be reported. (-bga)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 <param name="scale" type="float" value="1.0"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62 label="Scale the coverage by a constant factor"
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
63 help="Each bedGraph coverage value is multiplied by this factor before being reported. Useful for normalizing coverage by, e.g., reads per million (RPM). (-scale)" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 <when value="hist">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 <param name="max" type="integer" label="Specify max depth" value="0"
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
67 help="Combine all positions with a depth >= max into a single bin in the histogram. (-max)" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 </when>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </conditional>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 <expand macro="split" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <param name="strand" type="select" label="Calculate coverage based on" help="(-strand)">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 <option value="">both strands combined</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
73 <option value="-strand +">positive strand only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
74 <option value="-strand -">negative strand only</option>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
75 </param>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
76
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
77 <param name="d" type="boolean" checked="False" truevalue="-d" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
78 label="Report the depth at each genome position with 1-based coordinates" help="(-d)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
79 <param name="dz" type="boolean" checked="False" truevalue="-dz" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
80 label="Report the depth at each genome position with 0-based coordinatess" help="(-dz)" />
20
3fe00810c5a2 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6692e3a4fa1bf6e9a407735afdbb2454ed32b316
iuc
parents: 17
diff changeset
81 <param name="five" type="boolean" checked="False" truevalue="-5" falsevalue=""
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
82 label="Calculate coverage of 5’ positions" help="Instead of entire interval. (-5)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
83 <param name="three" type="boolean" checked="False" truevalue="-3" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
84 label="Calculate coverage of 3’ positions" help="Instead of entire interval. (-3)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
85 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
86 <outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
87 <data format="bedgraph" name="output">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
88 <change_format>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
89 <when input="report.report_select" value="hist" format="tabular" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
90 </change_format>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
91 </data>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
92 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
93 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
94 <test>
23
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
95 <param name="input_type_select" value="bed" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
96 <param name="input" value="genomeCoverageBed1.bed" ftype="bed" />
32
b0d5e752c0c5 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents: 26
diff changeset
97 <param name="genome_file_opts_selector" value="hist" />
23
2a576a9ef0cb planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents: 20
diff changeset
98 <param name="genome" value="genomeCoverageBed1.len" ftype="tabular" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
99 <param name="report_select" value="hist" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
100 <output name="output" file="genomeCoverageBed_result1.bed" ftype="tabular" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
101 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
102 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
103 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
104 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
105 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
106
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
107 This tool calculates the genome-wide coverage of intervals defined in a BAM or BED file and reports them in BedGraph format.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
108
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
109 .. image:: $PATH_TO_IMAGES/genomecov-glyph.png
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
110
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
111 .. class:: warningmark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
112
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
113 The input BED or BAM file must be sorted by chromosome name (but doesn't necessarily have to be sorted by start position).
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
114
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
115 -----
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
116
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
117 **Example 1**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
118
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
119 Input (BED format)-
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
120 Overlapping, un-sorted intervals::
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
121
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
122 chr1 140 176
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
123 chr1 100 130
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
124 chr1 120 147
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
125
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
126
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
127 Output (BedGraph format)-
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
128 Sorted, non-overlapping intervals, with coverage value on the 4th column::
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
129
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
130 chr1 100 120 1
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
131 chr1 120 130 2
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
132 chr1 130 140 1
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
133 chr1 140 147 2
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
134 chr1 147 176 1
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
135
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
136 -----
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
137
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
138 **Example 2 - with ZERO-Regions selected (assuming hg19)**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
139
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
140 Input (BED format)-
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
141 Overlapping, un-sorted intervals::
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
142
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
143 chr1 140 176
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
144 chr1 100 130
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
145 chr1 120 147
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
146
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
147
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
148 BedGraph output will contain five columns:
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
149
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
150 * 1. Chromosome name (or 'genome' for whole-genome coverage)
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
151 * 2. Coverage depth
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
152 * 3. The number of bases on chromosome (or genome) with depth equal to column 2.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
153 * 4. The size of chromosome (or entire genome) in base pairs
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
154 * 5. The fraction of bases on chromosome (or entire genome) with depth equal to column 2.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
155
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
156 **Example Output**:
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 23
diff changeset
157
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
158 chr2L 0 1379895 23011544 0.0599653
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
159 chr2L 1 837250 23011544 0.0363839
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
160 chr2L 2 904442 23011544 0.0393038
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
161 chr2L 3 913723 23011544 0.0397072
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
162 chr2L 4 952166 23011544 0.0413778
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
163 chr2L 5 967763 23011544 0.0420555
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
164 chr2L 6 986331 23011544 0.0428624
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
165 chr2L 7 998244 23011544 0.0433801
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
166 chr2L 8 995791 23011544 0.0432735
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
167 chr2L 9 996398 23011544 0.0432999
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
168
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
169
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
170 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
171 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
172 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
173 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
174 </tool>