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