annotate multiCov.xml @ 0:b8348686a0b9 draft

Imported from capsule None

<tool id="bedtools_multicovtbed" name="MultiCovBed" version="@WRAPPER_VERSION@.0">
    <description></description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <expand macro="stdio" />
    <command>
        bedtools multicov
        -bed $input1
        -bam 
        #for $bam in $bams:
            $bam.input
        #end for
        $strand
        -f $overlap
        $reciprocal
        $split
        -q $mapq
        $duplicate
        $failed
        $proper
        &gt; $output
    </command>
    <inputs>
        <param name="input1" format="bed" type="data" label="First sorted BED file" />
        <!-- Additional files, if the user needs more -->
        <repeat name="bams" title="Add BAM files" >
            <param name="input" format="bam" type="data" label="BAM file" />
        </repeat>
        <expand macro="strand2" />
        <expand macro="overlap" />
        <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." />
        <expand macro="split" />

        <param name="duplicate" type="boolean" checked="false" truevalue="-D" falsevalue="" label="Include duplicate reads. Default counts non-duplicates only" />
        <param name="failed" type="boolean" checked="false" truevalue="-F" falsevalue="" label=" 	Include failed-QC reads. Default counts pass-QC reads only" />
        <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." />
    </inputs>

    <outputs>
        <data format="bed" name="output" label="" />
    </outputs>
    <help>
    
**What it does**

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.

.. class:: infomark

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.

@REFERENCES@

    </help>
    <expand macro="citations" />
</tool>