annotate coverageBed.xml @ 11:e526617a6bb9 draft

Uploaded
author bernhardlutz
date Wed, 18 Jun 2014 15:07:04 -0400
parents
children c782e0edc4f1
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
11
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="bedtools_coveragebed" name="Compute both the depth and breadth of coverage" version="0.2.0">
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
2 <description>of features in file A across the features in file B (coverageBed)</description>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
9 coverageBed
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
10 #if $inputA.ext == "bam"
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
11 -abam '$inputA'
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
12 #else
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
13 -a '$inputA'
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
14 #end if
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
15 -b '$inputB'
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
16 $split
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
17 $strand
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
18 | sort -k1,1 -k2,2n
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
19 &gt; '$output'
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
20 </command>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
21 <inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
22 <param format="bed,bam,gff,gg3,vcf" name="inputA" type="data" label="Count how many intervals in this BED/VCF/GFF/BAM file (source)">
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
23 <validator type="unspecified_build" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
24 </param>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
25 <param format="bed,gff,gff3,vcf" name="inputB" type="data" label="overlap the intervals in this BED file (target)">
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
26 <validator type="unspecified_build" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
27 </param>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
28 <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"
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
29 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" />
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
30 <param name="strandedness" type="boolean" label="Force strandedness" truevalue="-s" falsevalue="" checked="false"
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
31 help="That is, only features in A are only counted towards coverage in B if they are the same strand."/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
32 </inputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
33
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
34 <outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
35 <data format="bed" name="output" metadata_source="inputB" label="count of overlaps in ${inputA.name} on ${inputB.name}"/>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
36 </outputs>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
37 <help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
38
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
39 **What it does**
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
40
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
41 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.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
42 Thus, coverageBed also computes the breadth of coverage for each interval in B.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
43
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
44 .. coverageBed: http://bedtools.readthedocs.org/en/latest/content/tools/coverage.html
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
45
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
46 .. class:: infomark
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
47
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
48 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.
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
49
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
50 @REFERENCES@
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
51
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
52 </help>
e526617a6bb9 Uploaded
bernhardlutz
parents:
diff changeset
53 </tool>