annotate qiime2__vizard__boxplot.xml @ 2:751a2433f1cc draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__vizard 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 vizard boxplot" id="qiime2__vizard__boxplot" version="0.0.1.dev0+q2galaxy.2025.7.0" profile="22.05" license="BSD-3-Clause">
    <description>Boxplot</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 vizard</version_command>
    <command detect_errors="exit_code">q2galaxy run vizard boxplot '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="staging_path_and_source_path"/>
    </configfiles>
    <inputs>
        <repeat name="metadata" min="1" help="[required]  Any metadata-like input with at least one numeric measure and one categorical measure for visualizing." title="metadata: Metadata">
            <conditional name="__q2galaxy__GUI__conditional__metadata__">
                <param name="type" type="select" label="metadata: Metadata">
                    <option value="tsv" selected="true">Metadata from TSV</option>
                    <option value="qza">Metadata from Artifact</option>
                </param>
                <when value="tsv">
                    <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
                </when>
                <when value="qza">
                    <param name="source" type="data" format="qza" label="Metadata Source"/>
                </when>
            </conditional>
        </repeat>
        <param name="distribution_measure" type="text" label="distribution_measure: Str" help="[required]  The numeric measure that will be used to create each box plot distribution.">
            <sanitizer>
                <valid initial="string.printable"/>
            </sanitizer>
            <validator type="expression" message="Please verify this parameter.">value is not None and len(value) &gt; 0</validator>
        </param>
        <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
            <conditional name="__q2galaxy__GUI__conditional__group_by__" label="group_by: Str">
                <param name="__q2galaxy__GUI__select__" type="select" label="group_by: Str" help="[optional]  The categorical measure that will be used to group the data into separate box plots. If left blank, all data will be represented within a single box.">
                    <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option>
                    <option value="__q2galaxy__::control::provide">Provide a value</option>
                </param>
                <when value="__q2galaxy__::control::default">
                    <param name="group_by" type="hidden" value="__q2galaxy__::literal::None"/>
                </when>
                <when value="__q2galaxy__::control::provide">
                    <param name="group_by" type="text">
                        <sanitizer>
                            <valid initial="string.printable"/>
                        </sanitizer>
                    </param>
                </when>
            </conditional>
            <param name="whisker_range" type="select" label="whisker_range: Str % Choices('tukeys_iqr', 'percentile', 'minmax')" display="radio">
                <option value="tukeys_iqr">tukeys_iqr</option>
                <option value="percentile" selected="true">percentile</option>
                <option value="minmax">minmax</option>
            </param>
            <param name="box_orientation" type="select" label="box_orientation: Str % Choices('horizontal', 'vertical')" display="radio">
                <option value="horizontal" selected="true">horizontal</option>
                <option value="vertical">vertical</option>
            </param>
            <conditional name="__q2galaxy__GUI__conditional__title__" label="title: Str">
                <param name="__q2galaxy__GUI__select__" type="select" label="title: Str" help="[optional]  The title of the boxplot.">
                    <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option>
                    <option value="__q2galaxy__::control::provide">Provide a value</option>
                </param>
                <when value="__q2galaxy__::control::default">
                    <param name="title" type="hidden" value="__q2galaxy__::literal::None"/>
                </when>
                <when value="__q2galaxy__::control::provide">
                    <param name="title" type="text">
                        <sanitizer>
                            <valid initial="string.printable"/>
                        </sanitizer>
                    </param>
                </when>
            </conditional>
        </section>
    </inputs>
    <outputs>
        <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
    </outputs>
    <tests/>
    <help>
QIIME 2: vizard boxplot
=======================
Boxplot


Outputs:
--------
:visualization.qzv: &lt;no description&gt;

|  

Description:
------------
Basic boxplot for visualizing a numeric Metadata measure grouped by a categorical Metadata measure with choices for the whisker range.


|  

</help>
    <citations>
        <citation type="doi">10.1038/s41587-019-0209-9</citation>
    </citations>
</tool>