annotate bedtools-galaxy/genomeCoverageBed_histogram.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_histogram" name="Create a histogram of genome coverage" version="0.1.0">
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
2 <description></description>
11
0ee50862dd67 Uploaded
aaronquinlan
parents: 10
diff changeset
3
0ee50862dd67 Uploaded
aaronquinlan
parents: 10
diff changeset
4 <requirements>
0ee50862dd67 Uploaded
aaronquinlan
parents: 10
diff changeset
5 <requirement type="binary">genomeCoverageBed</requirement>
0ee50862dd67 Uploaded
aaronquinlan
parents: 10
diff changeset
6 </requirements>
0ee50862dd67 Uploaded
aaronquinlan
parents: 10
diff changeset
7
10
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
8 <command>genomeCoverageBed
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
9 #if $input.ext == "bam"
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
10 -ibam '$input'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
11 #else
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
12 -i '$input'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
13 -g ${chromInfo}
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
14 #end if
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
15 #if str($max):
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
16 -max $max
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
17 #end if
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
18 &gt; '$output'
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
19 </command>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
20
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
21 <inputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
22 <param format="bed,bam" name="input" type="data" label="The BAM or BED file from which coverage should be computed"></param>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
23 <param name="max" type="text" optional="true" label="Max depth" help="Combine all positions with a depth >= max into a single bin in the histogram."/>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
24 </inputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
25
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
26 <outputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
27 <data format="tabular" name="output" metadata_source="input" label="${input.name} (Genome Coverage Histogram)" />
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
28 </outputs>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
29
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
30 <help>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
31 **What it does**
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
32
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
33 This tool calculates a histogram of genome coverage depth based on mapped reads in BAM format or intervals in BED format.
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
34
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
35
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
36 ------
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
37
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
38 .. class:: warningmark
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
39
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
40 This tool requires that `bedtools`__ has been installed on your system.
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
41
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
42 .. class:: infomark
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
43
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
44 The output file will contain five columns:
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
45
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
46 * 1. Chromosome name (or 'genome' for whole-genome coverage)
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
47 * 2. Coverage depth
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
48 * 3. The number of bases on chromosome (or genome) with depth equal to column 2.
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
49 * 4. The size of chromosome (or entire genome) in base pairs
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
50 * 5. The fraction of bases on chromosome (or entire genome) with depth equal to column 2.
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
51
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
52 **Example Output**::
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
53
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
54 chr2L 0 1379895 23011544 0.0599653
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
55 chr2L 1 837250 23011544 0.0363839
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
56 chr2L 2 904442 23011544 0.0393038
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
57 chr2L 3 913723 23011544 0.0397072
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
58 chr2L 4 952166 23011544 0.0413778
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
59 chr2L 5 967763 23011544 0.0420555
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
60 chr2L 6 986331 23011544 0.0428624
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
61 chr2L 7 998244 23011544 0.0433801
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
62 chr2L 8 995791 23011544 0.0432735
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
63 chr2L 9 996398 23011544 0.0432999
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
64
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
65
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
66
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
67
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
68 ------
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
69
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
70 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
71
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
72 .. __: http://code.google.com/p/bedtools/
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
73 .. __: http://code.google.com/p/bedtools/
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
74 .. __: http://cphg.virginia.edu/quinlan/
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
75 .. __: http://bioinformatics.oxfordjournals.org/content/26/6/841.short
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
76
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
77
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
78
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
79 </help>
d72fd57eb158 Uploaded
aaronquinlan
parents:
diff changeset
80 </tool>