Mercurial > repos > iuc > bedtools
annotate genomeCoverageBed.xml @ 50:df28283b3778 draft
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
| author | iuc |
|---|---|
| date | Mon, 29 Apr 2019 05:54:22 -0400 |
| parents | 2f457890d8c8 |
| children | 7a06bb42dbb1 |
| rev | line source |
|---|---|
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
1 <tool id="bedtools_genomecoveragebed" name="bedtools Genome Coverage" version="@TOOL_VERSION@"> |
|
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 | 3 <macros> |
| 4 <import>macros.xml</import> | |
| 5 </macros> | |
| 6 <expand macro="requirements" /> | |
| 7 <expand macro="stdio" /> | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
8 <command><![CDATA[ |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
9 bedtools genomecov |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
10 @GENOME_FILE_COVERAGE@ |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
11 |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
12 $split |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
13 $strand |
| 8 | 14 |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
15 #if str($report.report_select) == "bg": |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
16 #if $report.zero_regions: |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
17 $report.zero_regions |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
18 #else: |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
19 -bg |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
20 #end if |
| 8 | 21 |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
22 #if str($report.scale): |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
23 -scale $report.scale |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
24 #end if |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
25 #else: |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
26 #if str($report.max): |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
27 -max $report.max |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
28 #end if |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
29 #end if |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
30 $d |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
31 $dz |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
32 $five |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
33 $three |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
34 > '$output' |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
35 ]]></command> |
| 8 | 36 <inputs> |
|
23
2a576a9ef0cb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents:
20
diff
changeset
|
37 <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
|
38 <param name="input_type_select" type="select" label="Input type"> |
|
42
d279800f4ff9
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b75b9e79cf3186a22dc2e1e9d27c1a080b891b59
iuc
parents:
35
diff
changeset
|
39 <option value="bed">@STD_BEDTOOLS_INPUT_LABEL@</option> |
|
23
2a576a9ef0cb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents:
20
diff
changeset
|
40 <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
|
41 </param> |
|
2a576a9ef0cb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents:
20
diff
changeset
|
42 <when value="bed"> |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
43 <param name="input" argument="-i" type="data" format="@STD_BEDTOOLS_INPUTS@" label="@STD_BEDTOOLS_INPUT_LABEL@ file" /> |
|
32
b0d5e752c0c5
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit a78ca56350b1fcf9d7de2a1112155c9bd0844348
iuc
parents:
26
diff
changeset
|
44 <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
|
45 </when> |
|
2a576a9ef0cb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents:
20
diff
changeset
|
46 <when value="bam"> |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
47 <param name="input" argument="-ibam" type="data" format="bam" label="BAM 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 </conditional> |
| 8 | 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"> | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
56 <param name="zero_regions" argument="-bga" type="boolean" truevalue="-bga" falsevalue="" checked="false" |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
57 label="Report regions with zero coverage" help="If set, regions without any coverage will also be reported" /> |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
58 <param argument="-scale" type="float" value="1.0" |
| 8 | 59 label="Scale the coverage by a constant factor" |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
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)." /> |
| 8 | 61 </when> |
| 62 <when value="hist"> | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
63 <param argument="-max" type="integer" value="0" label="Specify max depth" |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
64 help="Combine all positions with a depth >= max into a single bin in the histogram" /> |
| 8 | 65 </when> |
| 66 </conditional> | |
| 67 <expand macro="split" /> | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
68 <param argument="-strand" type="select" label="Calculate coverage based on"> |
| 8 | 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 | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
74 <param argument="-d" type="boolean" truevalue="-d" falsevalue="" checked="false" |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
75 label="Report the depth at each genome position with 1-based coordinates" /> |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
76 <param argument="-dz" type="boolean" truevalue="-dz" falsevalue="" checked="false" |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
77 label="Report the depth at each genome position with 0-based coordinatess" /> |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
78 <param name="five" argument="-5" type="boolean" truevalue="-5" falsevalue="" checked="false" |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
79 label="Calculate coverage of 5’ positions" help="Instead of entire interval" /> |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
80 <param name="three" argument="-3" type="boolean" truevalue="-3" falsevalue="" checked="false" |
|
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
81 label="Calculate coverage of 3’ positions" help="Instead of entire interval" /> |
| 8 | 82 </inputs> |
| 83 <outputs> | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
84 <data name="output" format="bedgraph"> |
| 8 | 85 <change_format> |
| 86 <when input="report.report_select" value="hist" format="tabular" /> | |
| 87 </change_format> | |
| 88 </data> | |
| 89 </outputs> | |
| 90 <tests> | |
| 91 <test> | |
|
23
2a576a9ef0cb
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 964b3159deeade1c90d20cef92dc15a14195edb7
iuc
parents:
20
diff
changeset
|
92 <param name="input_type_select" value="bed" /> |
| 8 | 93 <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
|
94 <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
|
95 <param name="genome" value="genomeCoverageBed1.len" ftype="tabular" /> |
| 8 | 96 <param name="report_select" value="hist" /> |
| 97 <output name="output" file="genomeCoverageBed_result1.bed" ftype="tabular" /> | |
| 98 </test> | |
| 99 </tests> | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
100 <help><![CDATA[ |
| 8 | 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**: | |
|
26
c0fbce5dc84a
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents:
23
diff
changeset
|
153 |
| 8 | 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@ | |
|
50
df28283b3778
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit b68002321ade5e160c556517a98ffb70f068be95
iuc
parents:
48
diff
changeset
|
167 ]]></help> |
| 8 | 168 <expand macro="citations" /> |
| 169 </tool> |
