annotate multiCov.xml @ 12:c782e0edc4f1 draft default tip

Uploaded
author bgruening
date Thu, 19 Jun 2014 10:12:00 -0400
parents 75d323631dce
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
12
c782e0edc4f1 Uploaded
bgruening
parents: 6
diff changeset
1 <tool id="bedtools_multicovtbed" name="MultiCovBed" version="@WRAPPER_VERSION@.0">
6
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
2 <description></description>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
3 <macros>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
4 <import>macros.xml</import>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
5 </macros>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
6 <expand macro="requirements" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
7 <expand macro="stdio" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
8 <command>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
9 bedtools multicov
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
10 -bed $input1
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
11 -bam
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
12 #for $bam in $bams:
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
13 $bam.input
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
14 #end for
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
15 $strand
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
16 -f $overlap
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
17 $reciprocal
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
18 $split
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
19 -q $mapq
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
20 $duplicate
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
21 $failed
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
22 $proper
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
23 &gt; $output
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
24 </command>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
25 <inputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
26 <param name="input1" format="bed" type="data" label="First sorted BED file" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
27 <!-- Additional files, if the user needs more -->
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
28 <repeat name="bams" title="Add BAM files" >
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
29 <param name="input" format="bam" type="data" label="BAM file" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
30 </repeat>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
31 <expand macro="strand2" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
32 <expand macro="overlap" />
75d323631dce Uploaded
bernhardlutz
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." />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
34 <expand macro="split" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
35
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
36 <param name="duplicate" type="boolean" checked="false" truevalue="-D" falsevalue="" label="Include duplicate reads. Default counts non-duplicates only" />
75d323631dce Uploaded
bernhardlutz
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" />
75d323631dce Uploaded
bernhardlutz
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." />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
39 </inputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
40
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
41 <outputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
42 <data format="bed" name="output" label="" />
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
43 </outputs>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
44 <help>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
45
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
46 **What it does**
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
47
75d323631dce Uploaded
bernhardlutz
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.
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
49
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
50 .. class:: infomark
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
51
75d323631dce Uploaded
bernhardlutz
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.
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
53
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
54 @REFERENCES@
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
55
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
56 </help>
75d323631dce Uploaded
bernhardlutz
parents:
diff changeset
57 </tool>