annotate multiCov.xml @ 2:effb7b4e45ed draft

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