annotate multiCov.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_multicovtbed" name="MultiCovBed" version="@WRAPPER_VERSION@.0">
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
2 <description></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 bedtools multicov
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
10 -bed $input1
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
11 -bam
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
12 #for $bam in $bams:
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
13 $bam.input
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
14 #end for
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
15 $strand
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
16 -f $overlap
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
17 $reciprocal
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
18 $split
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
19 -q $mapq
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
20 $duplicate
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
21 $failed
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
22 $proper
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
23 &gt; $output
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
24 </command>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
25 <inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
26 <param name="input1" format="bed" type="data" label="First sorted BED file" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
27 <!-- Additional files, if the user needs more -->
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
28 <repeat name="bams" title="Add BAM files" >
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
29 <param name="input" format="bam" type="data" label="BAM file" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
30 </repeat>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
31 <expand macro="strand2" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
32 <expand macro="overlap" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
33 <param name="reciprocal" type="boolean" checked="false" truevalue="-r" falsevalue="" label="Require that the fraction overlap be reciprocal for A and B. In other words, if -f is 0.90 and -r is used, this requires that B overlap 90% of A and A _also_ overlaps 90% of B." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
34 <expand macro="split" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
35
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
36 <param name="duplicate" type="boolean" checked="false" truevalue="-D" falsevalue="" label="Include duplicate reads. Default counts non-duplicates only" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
37 <param name="failed" type="boolean" checked="false" truevalue="-F" falsevalue="" label=" Include failed-QC reads. Default counts pass-QC reads only" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
38 <param name="proper" type="boolean" checked="false" truevalue="-p" falsevalue="" label="Only count proper pairs. Default counts all alignments with MAPQ > -q argument, regardless of the BAM FLAG field." />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
39 </inputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
40
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
41 <outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
42 <data format="bed" name="output" label="" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
43 </outputs>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
44 <help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
45
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
46 **What it does**
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
47
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
48 bedtools multicov, reports the count of alignments from multiple position-sorted and indexed BAM files that overlap intervals in a BED file. Specifically, for each BED interval provided, it reports a separate count of overlapping alignments from each BAM file.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
49
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
50 .. class:: infomark
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
51
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
52 bedtools multicov depends upon index BAM files in order to count the number of overlaps in each BAM file. As such, each BAM file should be position sorted (samtool sort aln.bam aln.sort) and indexed (samtools index aln.sort.bam) with either samtools or bamtools.
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
53
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
54 @REFERENCES@
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
55
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
56 </help>
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
57 <expand macro="citations" />
b8348686a0b9 Imported from capsule None
iuc
parents:
diff changeset
58 </tool>