annotate genomeCoverageBed_bedgraph.xml @ 2:effb7b4e45ed draft

Uploaded
author iuc
date Fri, 05 Dec 2014 13:31:24 -0500
parents 7511823bdea1
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_genomecoveragebed_bedgraph" name="Create a BedGraph of genome coverage" version="@WRAPPER_VERSION@.0">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
2 <description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
3 </description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
4 <macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
5 <import>macros.xml</import>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
6 </macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
8 <expand macro="stdio" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
9 <command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
10 genomeCoverageBed
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
11 #if $input.ext == "bam"
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
12 -ibam '$input'
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
13 #else
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
14 -i '$input'
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
15 -g ${chromInfo}
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
16 #end if
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
17
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
18 #if str($scale):
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
19 -scale $scale
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
20 #end if
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
21
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
22 -bg
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
23 $zero_regions
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
24 $split
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
25 $strand
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
26 &gt; '$output'
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
27 </command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
28 <inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
29 <param format="bed,bam" name="input" type="data" label="The BAM or BED file from which coverage should be computed">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
30 <validator type="unspecified_build" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
31 </param>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
32
4fb5ea02b441 Uploaded
iuc
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." />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
34
4fb5ea02b441 Uploaded
iuc
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." />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
36
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
37 <param name="strand" type="select" label="Calculate coverage based on">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
38 <option value="">both strands combined</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
39 <option value="-strand +">positive strand only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
40 <option value="-strand -">negative strand only</option>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
41 </param>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
42
4fb5ea02b441 Uploaded
iuc
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)"/>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
44 </inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
45 <outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
46 <data format="bedgraph" name="output" metadata_source="input" label="${input.name} (Genome Coverage BedGraph)" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
47 </outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
48 <help>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
49
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
50
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
51 **What it does**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
52
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
53 This tool calculates the genome-wide coverage of intervals defined in a BAM or BED file and reports them in BedGraph format.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
54
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
55 .. class:: warningmark
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
56
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
57 The input BED or BAM file must be sorted by chromosome name (but doesn't necessarily have to be sorted by start position).
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
58
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
59 -----
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
60
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
61 **Example 1**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
62
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
63 Input (BED format)-
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
64 Overlapping, un-sorted intervals::
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
65
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
66 chr1 140 176
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
67 chr1 100 130
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
68 chr1 120 147
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
69
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
70
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
71 Output (BedGraph format)-
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
72 Sorted, non-overlapping intervals, with coverage value on the 4th column::
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
73
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
74 chr1 100 120 1
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
75 chr1 120 130 2
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
76 chr1 130 140 1
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
77 chr1 140 147 2
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
78 chr1 147 176 1
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
79
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
80 -----
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
81
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
82 **Example 2 - with ZERO-Regions selected (assuming hg19)**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
83
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
84 Input (BED format)-
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
85 Overlapping, un-sorted intervals::
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
86
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
87 chr1 140 176
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
88 chr1 100 130
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
89 chr1 120 147
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
90
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
91
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
92 Output (BedGraph format)-
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
93 Sorted, non-overlapping intervals, with coverage value on the 4th column::
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
94
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
95 chr1 0 100 0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
96 chr1 100 120 1
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
97 chr1 120 130 2
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
98 chr1 130 140 1
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
99 chr1 140 147 2
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
100 chr1 147 176 1
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
101 chr1 176 249250621 0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
102
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
103 @REFERENCES@
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
104 </help>
1
7511823bdea1 Uploaded
iuc
parents: 0
diff changeset
105 <expand macro="citations" />
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
106 </tool>