annotate resample.xml @ 4:184dfd9e113d draft

"planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/circos commit f5db2969e8602eff32ec799d237875b911578fe5"

<?xml version="1.0"?>
<tool id="circos_resample" name="Circos: Resample 1/2D data" version="@WRAPPER_VERSION@">
    <description>reduce numbers of points in a dataset before plotting</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements" />
    <command detect_errors="exit_code"><![CDATA[
resample
    -bin '$bins'
    $method
    < '$input' | sed 's/ /\t/g' > '$output'
    ]]></command>
    <inputs>
        <param name="input" type="data" format="tabular" label="1D/2D Data track"/>
        <param name="bins" type="integer" value="1000000" min="1" label="Bin size" />

        <param name="method" type="select" label="Summarization method">
            <option value="-avg">[2D] Average</option>
            <option value="-min">[2D] Minimum value in bin</option>
            <option value="-max">[2D] Maximum value in bin</option>
            <option value="-sum">[2D] Sum of values in bin</option>
            <option value="-count">[1D] Count bins</option>
        </param>
    </inputs>
    <outputs>
        <data name="output" format="tabular" />
    </outputs>
    <tests>
        <test>
            <param name="input" value="resample/1.tab" ftype="tabular" />
            <param name="bins" value="10000000" />
            <output name="output" file="resample/1.out" ftype="tabular" />
        </test>
    </tests>
    <help><![CDATA[
From the script's documentation:

    The data resolution in a figure is limited by the output print, or screen,
    resolution and our own visual acuity.

    To read more about how these limits affect figure design, see
    `this page <http://mkweb.bcgsc.ca/images/resolution/visual-acuity-sequence-visualization.pdf>`__

    This script is designed to convert very high-resolution data tracks to
    low-resolution equivalents which are easier to interpret and faster to
    draw.

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