annotate anosim.xml @ 0:08ccc12f2a3a draft

planemo upload for repository https://github.com/galaxyproject/tools-iuc/tree/master/tools/mothur commit a9d1e0debcd357d8080a1c6c5f1d206dd45a7a4d

<tool profile="16.07" id="mothur_anosim" name="Anosim" version="@WRAPPER_VERSION@.0">
    <description>Non-parametric multivariate analysis of changes in community structure</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="requirements"/>
    <expand macro="stdio"/>
    <expand macro="version_command"/>
    <command><![CDATA[
        @SHELL_OPTIONS@

        ## create symlinks to input datasets
        ln -s "$dist" dist.dat &&
        ln -s "$design" design.dat &&

        echo 'anosim(
            phylip=dist.dat,
            iters=$iters,
            alpha=$alpha,
            design=design.dat
        )'
        | sed 's/ //g'  ## mothur trips over whitespace
        | mothur
        | tee mothur.out.log
    ]]></command>
    <inputs>
        <param name="dist" type="data" format="mothur.dist,mothur.lower.dist,mothur.square.dist" label="phylip - Distance Matrix"/>
        <param name="design" type="data" format="tabular" label="design - assign groups to new grouping" help="design has 2 columns: group(col 1) and grouping(col 2) (separated by a TAB character)"/>
        <param name="alpha" type="float" optional="true" value="0.05" min="0" label="alpha - acceptable stopping precision (default 0.05)"/>
        <param name="iters" type="integer" value="1000" min="0" label="iters - Number of random configuration to try (default 1000)"/>
    </inputs>
    <outputs>
        <expand macro="logfile-output"/>
        <data name="anosim" format="tabular" from_work_dir="dist.anosim" label="${tool.name} on ${on_string}: anosim"/>
    </outputs>
    <tests>
        <test>
            <param name="dist" value="amazon.dist"/>
            <param name="design" value="amazon.design"/>
            <output name="anosim" ftype="tabular">
                <assert_contents>
                    <has_line_matching expression="^comparison\tR-value\tP-value$"/>
                    <has_line_matching expression="^A-B\t[0-9\.\-]+\t[0-9\.]+$"/>
                </assert_contents>
            </output>
            <expand macro="logfile-test"/>
        </test>
    </tests>
    <help>
<![CDATA[

@MOTHUR_OVERVIEW@

**Command Documentation**

The anosim_ command uses a phylip_distance_matrix_ and a design file to calculate the non-parametric multivariate analysis of changes in community structure.

A design file partitions a list of names into groups.  It is a tab-delimited file with 2 columns: name and group, e.g. :
        ======= =======
        duck    bird
        cow     mammal
        pig     mammal
        goose   bird
        cobra   reptile
        ======= =======

The Make_Design tool can construct a design file from a Mothur dataset that contains group names.


.. _phylip_distance_matrix: https://www.mothur.org/wiki/Phylip-formatted_distance_matrix
.. _anosim: https://www.mothur.org/wiki/Anosim

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