Mercurial > repos > iuc > bedtools

annotate coverageBed.xml @ 26:c0fbce5dc84a draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
author iuc
date Mon, 17 Oct 2016 10:13:20 -0400
parents 6c6963cf9136
children ada98688209b
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 25
diff changeset
1 <tool id="bedtools_coveragebed" name="Compute both the depth and breadth of coverage" version="@WRAPPER_VERSION@.0">
25
6c6963cf9136 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit bad476ff5076338f3eebdf0c25bb5a6c745e5592
iuc
parents: 24
diff changeset
2 <description>of features in file B on the features in file A (bedtools coverage)</description>
8
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[
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
10 #set inputBs = "' '".join([str($file) for $file in $inputB])
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
11
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
12 bedtools coverage
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
13 $d
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
14 $hist
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
15 $split
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
16 $strandedness
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
17 -a '$inputA'
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
18 -b '$inputBs'
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
19 | sort -k1,1 -k2,2n
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
20 > '$output'
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
21 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
22 </command>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
23 <inputs>
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
24 <param format="bam,bed,gff,gff3,vcf" name="inputA" type="data" label="File A (on which coverage is calculated)" help="BAM/BED/GFF/VCF format" />
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
25 <param format="bam,bed,gff,gff3,vcf" name="inputB" type="data" multiple="true" label="File(s) B (for which coverage is calculated)" help="BAM/BED/GFF/VCF format" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
26 <expand macro="split" />
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 25
diff changeset
27 <param name="strandedness" type="boolean" label="Force strandedness" truevalue="-s" falsevalue="" checked="false"
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
28 help="Only report hits in B that overlap A on the same strand. By default, overlaps are reported without respect to strand (-s)"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
29 <param name="d" type="boolean" checked="false" truevalue="-d" falsevalue=""
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
30 label="Report the depth at each position in each A feature"
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
31 help="Positions reported are one based. Each position and depth follow the complete B feature (-d)" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
32 <param name="hist" type="boolean" checked="false" truevalue="-hist" falsevalue=""
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
33 label="Report a histogram of coverage for each feature in A as well as a summary histogram for all features in A"
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
34 help="Additional columns after each feature in A: 1) depth 2) # bases at depth 3) size of A 4) % of A at depth (-hist)" />
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
35 </inputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
36 <outputs>
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
37 <data format="bed" name="output" metadata_source="inputA" label="Count of overlaps on ${inputA.name}"/>
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
38 </outputs>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
39 <tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
40 <test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
41 <param name="inputA" value="coverageBedA.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
42 <param name="genome" value="coverageBedB.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
43 <output name="output" file="coverageBed_result1.bed" ftype="bed" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
44 </test>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
45 </tests>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
46 <help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
47 <![CDATA[
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
48 **What it does**
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
49
26
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 25
diff changeset
50 `bedtools coverage`_ computes both the *depth* and *breadth* of coverage of features in
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 25
diff changeset
51 file B on the features in file A. For example, ``bedtools coverage`` can compute the coverage of sequence alignments
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 25
diff changeset
52 (file B) across 1 kilobase (arbitrary) windows (file A) tiling a genome of interest.
c0fbce5dc84a planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 19967671ddd4e750f53d71274e5c12325a402811
iuc
parents: 25
diff changeset
53 One advantage that ``bedtools coverage`` offers is that it not only *counts* the number of features that
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
54 overlap an interval in file A, it also computes the fraction of bases in the interval in A that were overlapped by one or more features.
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
55 Thus, ``bedtools coverage`` also computes the *breadth* of coverage for each interval in A.
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
56
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
57 .. _bedtools coverage: http://bedtools.readthedocs.org/en/latest/content/tools/coverage.html
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
58
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
59 .. class:: infomark
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
60
22
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
61 The lines in the output will be comprised of each interval in A, followed by:
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
62
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
63 1. The number of features in B that overlapped (by at least one base pair) the A interval.
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
64 2. The number of bases in A that had non-zero coverage from features in B.
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
65 3. The length of the entry in A.
ac8b17b66663 planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/bedtools commit 6ce9a5a91d803b9ac9e743d9721ff0ccd2a5a59f
iuc
parents: 8
diff changeset
66 4. The fraction of bases in A that had non-zero coverage from features in B.
8
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
67
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
68 @REFERENCES@
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
69 ]]>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
70 </help>
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
71 <expand macro="citations" />
0d3aa592ce27 Uploaded
iuc
parents:
diff changeset
72 </tool>