annotate bedtools-galaxy/genomeCoverageBed_bedgraph.xml @ 0:26c21c634c51

Uploaded
author aaronquinlan
date Thu, 29 Dec 2011 10:20:07 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
1 <tool id="bedtools_genomecoveragebed_bedgraph" name="Create a BedGraph of genome coverage" version="0.1.0">
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
2
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
3 <description>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
4 </description>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
5
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
6 <requirements>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
7 <requirement type="binary">genomeCoverageBed</requirement>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
8 </requirements>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
9
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
10 <command>genomeCoverageBed
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
11 #if $input.ext == "bam"
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
12 -ibam '$input'
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
13 #else
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
14 -i '$input'
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
15 -g ${chromInfo}
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
16 #end if
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
17
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
18 #if str($scale):
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
19 -scale $scale
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
20 #end if
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
21
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
22 -bg
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
23 $zero_regions
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
24 $split
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
25 $strand
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
26 &gt; '$output'
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
27 </command>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
28
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
29 <inputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
30 <param format="bed,bam" name="input" type="data" label="The BAM or BED file from which coverage should be computed">
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
31 <validator type="unspecified_build" />
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
32 </param>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
33
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
34 <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." />
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
35
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
36 <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." />
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
37
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
38 <param name="strand" type="select" label="Calculate coverage based on">
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
39 <option value="">both strands combined</option>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
40 <option value="-strand +">positive strand only</option>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
41 <option value="-strand -">negative strand only</option>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
42 </param>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
43
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
44 <param name="scale" type="text" 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)"/>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
45 </inputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
46
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
47 <outputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
48 <data format="bedgraph" name="output" metadata_source="input" label="${input.name} (Genome Coverage BedGraph)" />
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
49 </outputs>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
50 <help>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
51
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
52
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
53 **What it does**
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
54
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
55 This tool calculates the genome-wide coverage of intervals defined in a BAM or BED file and reports them in BedGraph format.
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
56
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
57 .. class:: warningmark
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
58
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
59 The input BED or BAM file must be sorted by chromosome name (but doesn't necessarily have to be sorted by start position).
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
60
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
61 .. class:: warningmark
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
62
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
63 This tool requires that `bedtools`__ has been installed on your system.
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
64
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
65 -----
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
66
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
67 **Example 1**
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
68
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
69 Input (BED format)-
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
70 Overlapping, un-sorted intervals::
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
71
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
72 chr1 140 176
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
73 chr1 100 130
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
74 chr1 120 147
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
75
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
76
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
77 Output (BedGraph format)-
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
78 Sorted, non-overlapping intervals, with coverage value on the 4th column::
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
79
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
80 chr1 100 120 1
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
81 chr1 120 130 2
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
82 chr1 130 140 1
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
83 chr1 140 147 2
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
84 chr1 147 176 1
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
85
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
86 -----
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
87
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
88 **Example 2 - with ZERO-Regions selected (assuming hg19)**
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
89
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
90 Input (BED format)-
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
91 Overlapping, un-sorted intervals::
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
92
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
93 chr1 140 176
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
94 chr1 100 130
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
95 chr1 120 147
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
96
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
97
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
98 Output (BedGraph format)-
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
99 Sorted, non-overlapping intervals, with coverage value on the 4th column::
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
100
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
101 chr1 0 100 0
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
102 chr1 100 120 1
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
103 chr1 120 130 2
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
104 chr1 130 140 1
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
105 chr1 140 147 2
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
106 chr1 147 176 1
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
107 chr1 176 249250621 0
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
108
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
109
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
110 This tool is part of the `bedtools package`__ from the `Quinlan laboratory`__. If you use this tool, please cite `Quinlan AR, and Hall I.M. BEDTools: A flexible framework for comparing genomic features. Bioinformatics, 2010, 26, 6.`__
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
111
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
112 .. __: http://code.google.com/p/bedtools/
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
113 .. __: http://code.google.com/p/bedtools/
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
114 .. __: http://cphg.virginia.edu/quinlan/
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
115 .. __: http://bioinformatics.oxfordjournals.org/content/26/6/841.short
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
116 </help>
26c21c634c51 Uploaded
aaronquinlan
parents:
diff changeset
117 </tool>