annotate kraken-report.xml @ 7:1c677354ab18 draft default tip

planemo upload for repository https://github.com/galaxyproject/tools-iuc/blob/master/tool_collections/kraken/ commit 3a94fbf6a188ea81441ef2f654ba5a74bff56f22

<tool id="kraken-report" name="Kraken-report" version="@WRAPPER_VERSION@">
    <description>view sample report of a classification</description>

    <macros>
        <import>macros.xml</import>
    </macros>
    <expand macro="xrefs"/>
    <expand macro="requirements" />
    <expand macro="version_command" />
    <command detect_errors="exit_code"><![CDATA[
        @SET_DATABASE_PATH@ &&

        kraken-report
            @INPUT_DATABASE@
            '${kraken_output}'
            > '$output_report'
    ]]></command>
    <inputs>
        <param name="kraken_output" type="data" format="tabular" label="Kraken output" help="Select taxonomy classification produced by kraken"/>

        <expand macro="input_database" />
    </inputs>
    <outputs>
        <data format="tabular" name="output_report" />
    </outputs>
    <tests>
        <test>
            <param name="kraken_output" value="kraken-report/kraken_report_test1.tab" ftype="tabular"/>
            <param name="kraken_database" value="new_style_test_entry"/>
            <output name="output_report" ftype="tabular" file="kraken-report/kraken_report_test1_output.tab"/>
        </test>
    </tests>

    <help><![CDATA[

.. class:: warningmark

**Note**: the database used must be the same as the one used in the original Kraken run

-----

**Output**

The output of kraken-report is tab-delimited, with one line per taxon. The fields of the output, from left-to-right, are as follows::

 1. Percentage of reads covered by the clade rooted at this taxon
 2. Number of reads covered by the clade rooted at this taxon
 3. Number of reads assigned directly to this taxon
 4. A rank code, indicating (U)nclassified, (D)omain, (K)ingdom, (P)hylum, (C)lass, (O)rder, (F)amily, (G)enus, or (S)pecies. All other ranks are simply filled with a dash.
 5. NCBI taxonomy ID
 6. Indented scientific name

The scientific names are indented using spaces, according to the tree
structure specified by the taxonomy.
    ]]></help>
    <expand macro="citations" />
</tool>