annotate bedtools-galaxy/genomeCoverageBed_bedgraph.xml @ 11:0ee50862dd67 default tip

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