annotate qiime2__diversity_lib__shannon_entropy.xml @ 7:c80939f5905d draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity_lib commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2025, QIIME 2 development team.

Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
-->
<!--
This tool was automatically generated by:
    q2galaxy (version: 2025.7.0)
for:
    qiime2 (version: 2025.7.0)
-->
<tool name="qiime2 diversity-lib shannon-entropy" id="qiime2__diversity_lib__shannon_entropy" version="2025.7.0+q2galaxy.2025.7.0" profile="22.05" license="BSD-3-Clause">
    <description>Shannon's Entropy</description>
    <xrefs>
        <xref type="bio.tools">qiime2</xref>
    </xrefs>
    <requirements>
        <container type="docker">quay.io/qiime2/amplicon:2025.7</container>
    </requirements>
    <version_command>q2galaxy version diversity_lib</version_command>
    <command detect_errors="exit_code">q2galaxy run diversity_lib shannon_entropy '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="staging_path_and_source_path"/>
    </configfiles>
    <inputs>
        <param name="table" type="data" format="qza" label="table: FeatureTable[Frequency | RelativeFrequency]" help="[required]  The feature table containing the samples for which Shannon's Entropy should be computed.">
            <options options_filter_attribute="metadata.semantic_type">
                <filter type="add_value" value="FeatureTable[RelativeFrequency]"/>
                <filter type="add_value" value="FeatureTable[Frequency]"/>
            </options>
            <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[Frequency]', 'FeatureTable[RelativeFrequency]']</validator>
        </param>
        <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
            <param name="drop_undefined_samples" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="drop_undefined_samples: Bool" help="[default: No]  Samples with no observed features produce undefined (NaN) values. If true, these samples are dropped from the output vector."/>
        </section>
    </inputs>
    <outputs>
        <data name="vector" format="qza" label="${tool.name} on ${on_string}: vector.qza" from_work_dir="vector.qza"/>
    </outputs>
    <tests>
        <test>
            <param name="table" value="shannon_entropy.test0.feature-table.qza" ftype="qza"/>
            <output name="vector" ftype="qza">
                <assert_contents>
                    <has_archive_member path="[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\/metadata.yaml">
                        <has_line_matching expression="type: SampleData\[AlphaDiversity\]"/>
                    </has_archive_member>
                </assert_contents>
            </output>
        </test>
        <test>
            <param name="table" value="shannon_entropy.test1.feature-table.qza" ftype="qza"/>
            <param name="drop_undefined_samples" value="__q2galaxy__::literal::True"/>
            <output name="vector" ftype="qza">
                <assert_contents>
                    <has_archive_member path="[0-9a-f]{8}-[0-9a-f]{4}-[4][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}\/metadata.yaml">
                        <has_line_matching expression="type: SampleData\[AlphaDiversity\]"/>
                    </has_archive_member>
                </assert_contents>
            </output>
        </test>
    </tests>
    <help>
QIIME 2: diversity-lib shannon-entropy
======================================
Shannon's Entropy


Outputs:
--------
:vector.qza: Vector containing per-sample values for Shannon's Entropy.

|  

Description:
------------
Compute Shannon's Entropy for each sample in a feature table

Examples:
---------

basic
*****
Using the ``qiime2 diversity-lib shannon-entropy`` tool:
 #. Set *"table"* to ``#: feature-table.qza``
 #. Press the ``Execute`` button.

Once completed, for the new entry in your history, use the ``Edit`` button to set the name as follows:
 (Renaming is optional, but it will make any subsequent steps easier to complete.)

 .. list-table::
    :align: left
    :header-rows: 1

    * - History Name
      - *"Name"* to set (be sure to press ``Save``)
    * - ``#: qiime2 diversity-lib shannon-entropy [...] : vector.qza``
      - ``shannon-vector.qza``

dropping undefined samples
**************************
Using the ``qiime2 diversity-lib shannon-entropy`` tool:
 #. Set *"table"* to ``#: feature-table.qza``
 #. Expand the ``additional options`` section

    - Set *"drop_undefined_samples"* to ``Yes``

 #. Press the ``Execute`` button.

Once completed, for the new entry in your history, use the ``Edit`` button to set the name as follows:
 (Renaming is optional, but it will make any subsequent steps easier to complete.)

 .. list-table::
    :align: left
    :header-rows: 1

    * - History Name
      - *"Name"* to set (be sure to press ``Save``)
    * - ``#: qiime2 diversity-lib shannon-entropy [...] : vector.qza``
      - ``shannon-vector.qza``


|  

</help>
    <citations>
        <citation type="doi">10.1002/j.1538-7305.1948.tb01338.x</citation>
        <citation type="doi">10.1038/s41587-019-0209-9</citation>
    </citations>
</tool>