annotate macros.xml @ 0:b8348686a0b9 draft

Imported from capsule None

<macros>
    <xml name="requirements">
        <requirements>
            <requirement type="package" version="2.19.1">bedtools</requirement>
        </requirements>
        <version_command>bedtools --version</version_command>
    </xml>
    <token name="@WRAPPER_VERSION@">2.19</token>
    <xml name="stdio">
        <stdio>
            <!-- Anything other than zero is an error -->
            <exit_code range="1:" />
            <exit_code range=":-1" />
            <!-- In case the return code has not been set propery check stderr too -->
            <regex match="Error:" />
            <regex match="Exception:" />
        </stdio>
    </xml>

    <xml name="overlap">
        <param name="overlap" type="float" value="0.000000001" label="Minimum overlap required as a fraction of A" />
    </xml>
    <xml name="strand2">
        <param name="strand" type="select" label="Calculation based on strandedness?">
            <option value="" selected="True">Overlaps on either strand</option>
            <option value="-s">Only overlaps occurring on the **same** strand.</option>
            <option value="-S">Only overlaps occurring on the **opposite** strand.</option>
        </param>
    </xml>
    <xml name="seed">
        <conditional name="seed">
            <param name="choose" type="boolean" label="Choose Seed?" selected="False" truevalue="True" falsevalue="False" />
            <when value="True">
                <param name="seed" type="integer" value="12345" label="Enter Seed" />
            </when>
        </conditional>
    </xml>
    <xml name="split">
        <param name="split" type="boolean" checked="true" truevalue="-split" falsevalue="" 
            label="Treat split/spliced BAM or BED12 entries as distinct BED intervals when computing coverage." 
            help="If set, the coverage will be calculated based the spliced intervals only. For BAM files, this inspects the CIGAR N operation to infer the blocks for computing coverage. For BED12 files, this inspects the BlockCount, BlockStarts, and BlockEnds fields (i.e., columns 10,11,12). If this option is not set, coverage will be calculated based on the interval's START/END coordinates, and would include introns in the case of RNAseq data." />
    </xml>
    <xml name="genome">
        <param format="bed,vcf,gff,gff3" name="genome" type="data" label="Genome file" />
    </xml>
    <xml name="addition">
        <conditional name="addition">
            <param name="addition_select" type="select" label="Choose what you want to do">
                <option value="b" selected="True">Increase the BED/GFF/VCF entry by the same number base pairs in each direction.</option>
                <option value="lr">Increase by Start Coordinate and End Coordinate</option>
            </param>
            <when value="b">
                <param name="b" label="Give Value" type="integer" value="0"  />
            </when>
            <when value="lr">
                <param name="l" label="The number of base pairs to subtract from the start coordinate" type="integer" value="0" />
                <param name="r" label="The number of base pairs to add to the end coordinate" type="integer" value="0" />
            </when>
        </conditional>
    </xml>
    <xml name="math_options">
            <option value="min">Min - numeric only</option>
            <option value="max">Max - numeric only</option>
             <option value="mean">Mean - numeric only</option>
            <option value="median">Median - numeric only</option>
            <option value="mode">Mode - numeric only</option>
            <option value="antimode">Antimode - numeric only</option>
            <option value="collapse">collapse (i.e., print a comma separated list) - numeric or text</option>
       </xml>
    <xml name="additional_math_options">
            <option value="count">Count - numeric or text</option>
            <option value="count_disctinct">Count Distinct - numeric or text</option>
            <option value="distinct">distinct (i.e., print a comma separated list) - numeric or text</option>
            <option value="concat">concat (i.e., print a comma separated list) - numeric or text</option>
    </xml>
    <token name="@REFERENCES@">
------

This tool is part of the `bedtools package`_ from the `Quinlan laboratory`_.

.. _bedtools package: https://github.com/arq5x/bedtools2
.. _Quinlan laboratory: http://cphg.virginia.edu/quinlan/

    </token>
    <xml name="citations">
        <citations>
            <citation type="doi">10.1093/bioinformatics/btq033</citation>
        </citations>
    </xml>
</macros>