annotate genomeCoverageBed_histogram.xml @ 0:4fb5ea02b441 draft

Uploaded
author iuc
date Tue, 15 Jul 2014 14:42:23 -0400
parents
children 7511823bdea1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_genomecoveragebed_histogram" name="Create a histogram of genome coverage" version="@WRAPPER_VERSION@.0">
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
2 <description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
3 </description>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
4 <macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
5 <import>macros.xml</import>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
6 </macros>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
7 <expand macro="requirements" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
8 <expand macro="stdio" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
9 <command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
10 genomeCoverageBed
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
11 #if $input.ext == "bam"
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
12 -ibam '$input'
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
13 #else
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
14 -i '$input'
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
15 -g ${chromInfo}
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
16 #end if
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
17 #if str($max):
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
18 -max $max
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
19 #end if
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
20 &gt; '$output'
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
21 </command>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
22
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
23 <inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
24 <param format="bed,bam" name="input" type="data" label="The BAM or BED file from which coverage should be computed"></param>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
25 <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."/>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
26 </inputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
27
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
28 <outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
29 <data format="tabular" name="output" metadata_source="input" label="${input.name} (Genome Coverage Histogram)" />
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
30 </outputs>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
31
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
32 <help>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
33 **What it does**
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
34
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
35 This tool calculates a histogram of genome coverage depth based on mapped reads in BAM format or intervals in BED format.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
36
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
37
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
38 ------
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
39
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
40
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
41 .. class:: infomark
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
42
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
43 The output file will contain five columns:
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
44
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
45 * 1. Chromosome name (or 'genome' for whole-genome coverage)
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
46 * 2. Coverage depth
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
47 * 3. The number of bases on chromosome (or genome) with depth equal to column 2.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
48 * 4. The size of chromosome (or entire genome) in base pairs
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
49 * 5. The fraction of bases on chromosome (or entire genome) with depth equal to column 2.
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
50
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
51 **Example Output**::
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
52
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
53 chr2L 0 1379895 23011544 0.0599653
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
54 chr2L 1 837250 23011544 0.0363839
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
55 chr2L 2 904442 23011544 0.0393038
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
56 chr2L 3 913723 23011544 0.0397072
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
57 chr2L 4 952166 23011544 0.0413778
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
58 chr2L 5 967763 23011544 0.0420555
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
59 chr2L 6 986331 23011544 0.0428624
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
60 chr2L 7 998244 23011544 0.0433801
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
61 chr2L 8 995791 23011544 0.0432735
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
62 chr2L 9 996398 23011544 0.0432999
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
63
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
64
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
65 @REFERENCES@
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
66 </help>
4fb5ea02b441 Uploaded
iuc
parents:
diff changeset
67 </tool>