annotate genomeCoverageBed.xml @ 31:e19bebe96cd2 draft

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