annotate beta_diversity.xml @ 4:c254d75b8b67 draft default tip

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

<tool id="krakentools_beta_diversity" name="Krakentools: calculates beta diversity (Bray-Curtis dissimilarity)" version="@TOOL_VERSION@+galaxy@VERSION_SUFFIX@" profile="@PROFILE@">
    <description>from Kraken, Krona and Bracken files</description>
    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="biotools"/>
    <expand macro="requirements"/>
    <expand macro="version"/>
    <command detect_errors="exit_code"><![CDATA[
beta_diversity.py 
    --inputs
    #for $input in $inputs 
        '$input' 
    #end for
    --type '$sample.type'
    #if $sample.type == 'kreport'
        --level '$sample.level'
    #else if $sample.type == 'krona'
        --level '$sample.level'
    #end if
    > '$output'
    ]]></command>
    <inputs>
        <param argument="--inputs" type="data" multiple="true" format="tabular" label="Taxonomy file(s)" help="The files can be generated by Kraken, Bracken or Krona"/>
        <conditional name="sample">
            <param argument="--type" type="select" label="Specify type of input file(s)">
                <option value="single" selected="true">Single tabular data file</option>
                <option value="simple">Tabular data files</option>
                <option value="bracken">Braken species abundance file</option>
                <option value="kreport">Kraken report file</option>
                <option value="krona">Krona file</option>
            </param>
            <when value="single"/>
            <when value="simple"/>
            <when value="bracken"/>
            <when value="kreport">
                <expand macro="param_level"/>
            </when>
            <when value="krona">
                <expand macro="param_level"/>
            </when>
        </conditional>

    </inputs>
    <outputs>
        <data name="output" format="txt" />
    </outputs>
    <tests>
        <test>
            <param name="inputs" value="beta_bracken_1.tabular,beta_bracken_2.tabular,beta_bracken_3.tabular"/>
            <param name="type" value="bracken"/>
            <output name="output" ftype="txt">
                <assert_contents>
                    <has_text text="0.629"/>
                    <has_text text="0.993"/>
                    <has_text text="0.995"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="inputs" value="beta_kreport_1.tabular,beta_kreport_2.tabular,beta_kreport_3.tabular"/>
            <param name="type" value="kreport"/>
            <output name="output" ftype="txt">
                <assert_contents>
                    <has_text text="0.584"/>
                    <has_text text="0.996"/>
                    <has_text text="0.995"/>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="inputs" value="beta_krona_1.tabular,beta_krona_2.tabular"/>
            <param name="type" value="krona"/>
            <param name="level" value="G"/>
            <output name="output" ftype="txt">
                <assert_contents>        
                    <has_text text="0.993"/>
                </assert_contents>
            </output>
        </test>
    </tests>
    <help><![CDATA[
KrakenTools is a suite of scripts to be used alongside the Kraken, KrakenUniq, Kraken 2, or Bracken programs. These scripts are designed to help Kraken users with downstream analysis of Kraken results. This program calculates the beta diversity (Bray-Curtis dissimilarity) from kraken, krona and bracken files.

Input
------
Bracken files, Kraken and Kracken2 report files and Krona files. Additionally, you can pass any tab-separated file and specify the columns with the taxonomical information and read counts (--cols).

Output
------
Beta diversity of the input files

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