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