annotate coverageBed.xml @ 0:b8348686a0b9 draft

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