annotate genomeCoverageBed_bedgraph.xml @ 5:b78d20957e7f draft

Uploaded
author bernhardlutz
date Thu, 05 Jun 2014 15:25:18 -0400
parents
children c782e0edc4f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
5
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="bedtools_genomecoveragebed_bedgraph" name="Create a BedGraph of genome coverage" version="0.2.0">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
2 <description>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
3 </description>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
4 <macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
5 <import>macros.xml</import>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
6 </macros>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="requirements" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
8 <expand macro="stdio" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
9 <command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
10 genomeCoverageBed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
11 #if $input.ext == "bam"
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
12 -ibam '$input'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
13 #else
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
14 -i '$input'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
15 -g ${chromInfo}
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
16 #end if
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
17
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
18 #if str($scale):
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
19 -scale $scale
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
20 #end if
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
21
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
22 -bg
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
23 $zero_regions
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
24 $split
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
25 $strand
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
26 &gt; '$output'
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
27 </command>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
28 <inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
29 <param format="bed,bam" name="input" type="data" label="The BAM or BED file from which coverage should be computed">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
30 <validator type="unspecified_build" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
31 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
32
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
33 <param name="zero_regions" type="boolean" checked="true" truevalue="-bga" falsevalue="" label="Report regions with zero coverage" help="If set, regions without any coverage will also be reported." />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
34
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
35 <param name="split" type="boolean" checked="false" truevalue="-split" falsevalue="" label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage." help="If set, the coverage will be calculated based the spliced intervals only. For BAM files, this inspects the CIGAR N operation to infer the blocks for computing coverage. For BED12 files, this inspects the BlockCount, BlockStarts, and BlockEnds fields (i.e., columns 10,11,12). If this option is not set, coverage will be calculated based on the interval's START/END coordinates, and would include introns in the case of RNAseq data." />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
36
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
37 <param name="strand" type="select" label="Calculate coverage based on">
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
38 <option value="">both strands combined</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
39 <option value="-strand +">positive strand only</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
40 <option value="-strand -">negative strand only</option>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
41 </param>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
42
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
43 <param name="scale" type="float" optional="true" label="Scale the coverage by a constant factor" help="Each BEDGRAPH coverage value is multiplied by this factor before being reported. Useful for normalizing coverage by, e.g., reads per million (RPM)"/>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
44 </inputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
45 <outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
46 <data format="bedgraph" name="output" metadata_source="input" label="${input.name} (Genome Coverage BedGraph)" />
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
47 </outputs>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
48
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
49 $ cat A.bed
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
50 chr1 10 20
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
51 chr1 20 30
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
52 chr2 0 500
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
53
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
54 $ cat my.genome
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
55 chr1 1000
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
56 chr2 500
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
57
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
58 $ bedtools genomecov -i A.bed -g my.genome
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
59 chr1 0 980 1000 0.98
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
60 chr1 1 20 1000 0.02
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
61 chr2 1 500 500 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
62 genome 0 980 1500 0.653333
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
63 genome 1 520 1500 0.346667
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
64
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
65 <help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
66
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
67
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
68 **What it does**
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
69
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
70 This tool calculates the genome-wide coverage of intervals defined in a BAM or BED file and reports them in BedGraph format.
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
71
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
72 .. class:: warningmark
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
73
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
74 The input BED or BAM file must be sorted by chromosome name (but doesn't necessarily have to be sorted by start position).
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
75
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
76 -----
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
77
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
78 **Example 1**
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
79
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
80 Input (BED format)-
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
81 Overlapping, un-sorted intervals::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
82
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
83 chr1 140 176
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
84 chr1 100 130
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
85 chr1 120 147
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
86
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
87
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
88 Output (BedGraph format)-
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
89 Sorted, non-overlapping intervals, with coverage value on the 4th column::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
90
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
91 chr1 100 120 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
92 chr1 120 130 2
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
93 chr1 130 140 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
94 chr1 140 147 2
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
95 chr1 147 176 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
96
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
97 -----
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
98
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
99 **Example 2 - with ZERO-Regions selected (assuming hg19)**
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
100
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
101 Input (BED format)-
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
102 Overlapping, un-sorted intervals::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
103
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
104 chr1 140 176
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
105 chr1 100 130
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
106 chr1 120 147
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
107
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
108
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
109 Output (BedGraph format)-
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
110 Sorted, non-overlapping intervals, with coverage value on the 4th column::
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
111
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
112 chr1 0 100 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
113 chr1 100 120 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
114 chr1 120 130 2
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
115 chr1 130 140 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
116 chr1 140 147 2
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
117 chr1 147 176 1
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
118 chr1 176 249250621 0
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
119
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
120 @REFERENCES@
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
121 </help>
b78d20957e7f Uploaded
bernhardlutz
parents:
diff changeset
122 </tool>