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