annotate bedtools-galaxy/genomeCoverageBed_bedgraph.xml @ 1:3b3e7774f51a draft

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