annotate coverageBed.xml @ 8:0d3aa592ce27 draft

Uploaded
author iuc
date Tue, 28 Apr 2015 22:56:34 -0400
parents
children ac8b17b66663
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
1 <tool id="bedtools_coveragebed" name="Compute both the depth and breadth of coverage" version="@WRAPPER_VERSION@.1">
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
2 <description>of features in file A across the features in file B (coverageBed)</description>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
3 <macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
4 <import>macros.xml</import>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
5 </macros>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
6 <expand macro="requirements" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
7 <expand macro="stdio" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
8 <command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
9 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
10 coverageBed
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
11 #if $inputA.ext == "bam"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
12 -abam '$inputA'
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 #else
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 -a '$inputA'
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 #end if
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 -b '$inputB'
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
17 $d
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
18 $hist
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 $split
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 $strandedness
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 | sort -k1,1 -k2,2n
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 > '$output'
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
24 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
25 <inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <param format="bed,bam,gff,gg3,vcf" name="inputA" type="data" label="Count how many intervals in this BED/VCF/GFF/BAM file (source)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
27 <param format="bed,gff,gff3,vcf" name="inputB" type="data" label="overlap the intervals in this BED file (target)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
28 <expand macro="split" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 <param name="strandedness" type="boolean" label="Force strandedness" truevalue="-s" falsevalue="" checked="false"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
30 help="That is, only features in A are only counted towards coverage in B if they are the same strand. (-s)"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
31 <param name="d" type="boolean" checked="false" truevalue="-d" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 label="Report the depth at each position in each B feature"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
33 help="Positions reported are one based. Each position and depth follow the complete B feature. (-d)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
34 <param name="hist" type="boolean" checked="false" truevalue="-hist" falsevalue=""
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 label="Report a histogram of coverage for each feature in B as well as a summary histogram for all features in B"
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 help="Additonal columns after each feature in B: 1) depth 2) # bases at depth 3) size of B 4) % of B at depth. (-hist)" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
37 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 <outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <data format="bed" name="output" metadata_source="inputB" label="Count of overlaps in ${inputA.name} on ${inputB.name}"/>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <param name="inputA" value="coverageBedA.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 <param name="genome" value="coverageBedB.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 <output name="output" file="coverageBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
50 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
51
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
52 coverageBed_ computes both the depth and breadth of coverage of features in
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
53 file A across the features in file B. For example, coverageBed can compute the coverage of sequence alignments
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
54 (file A) across 1 kilobase (arbitrary) windows (file B) tiling a genome of interest.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
55 One advantage that coverageBed offers is that it not only counts the number of features that
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56 overlap an interval in file B, it also computes the fraction of bases in B interval that were overlapped by one or more features.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
57 Thus, coverageBed also computes the breadth of coverage for each interval in B.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 .. _coverageBed: http://bedtools.readthedocs.org/en/latest/content/tools/coverage.html
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
61 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
62
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
63 The output file will be comprised of each interval from your original target BED file, plus an additional column indicating the number of intervals in your source file that overlapped that target interval.
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
64
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
65 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
66 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 </tool>