annotate qiime2__metadata__shuffle_groups.xml @ 5:d310fdba1caf draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 5f71b597c9495eae67a447744fded834f56ca1f7

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2024, 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: 2024.10.0)
for:
    qiime2 (version: 2024.10.1)
-->
<tool name="qiime2 metadata shuffle-groups" id="qiime2__metadata__shuffle_groups" version="2024.10.0+q2galaxy.2024.10.0" profile="22.05" license="BSD-3-Clause">
    <description>Shuffle values in a categorical sample metadata column.</description>
    <xrefs>
        <xref type="bio.tools">qiime2</xref>
    </xrefs>
    <requirements>
        <container type="docker">quay.io/qiime2/amplicon:2024.10</container>
    </requirements>
    <version_command>q2galaxy version metadata</version_command>
    <command detect_errors="exit_code">q2galaxy run metadata shuffle_groups '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="staging_path_and_source_path"/>
    </configfiles>
    <inputs>
        <conditional name="metadata">
            <param name="type" type="select" label="metadata: MetadataColumn[Categorical]" help="[required]  Categorical metadata column to shuffle.">
                <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"/>
                <param name="column" type="data_column" label="Column Name" data_ref="source" use_header_names="true">
                    <validator type="expression" message="The first column cannot be selected (they are IDs).">value != "1"</validator>
                </param>
            </when>
            <when value="qza">
                <param name="source" type="data" format="qza" label="Metadata Source"/>
                <param name="column" type="text" label="Column Name">
                    <validator type="empty_field"/>
                </param>
            </when>
        </conditional>
        <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
            <param name="n_columns" type="integer" value="3" label="n_columns: Int" help="[default: 3]  The number of shuffled metadata columns to create."/>
            <param name="md_column_name_prefix" type="text" value="shuffled.grouping." label="md_column_name_prefix: Str" help="[default: 'shuffled.grouping.']  Prefix to use in naming the shuffled metadata columns.">
                <sanitizer>
                    <valid initial="string.printable"/>
                </sanitizer>
            </param>
            <param name="md_column_values_prefix" type="text" value="fake.group." label="md_column_values_prefix: Str" help="[default: 'fake.group.']  Prefix to use in naming the values in the shuffled metadata columns.">
                <sanitizer>
                    <valid initial="string.printable"/>
                </sanitizer>
            </param>
            <param name="encode_sample_size" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="encode_sample_size: Bool" help="[default: No]  If true, the sample size of each metadata group will be appended to the shuffled metadata column values."/>
        </section>
    </inputs>
    <outputs>
        <data name="shuffled_groups" format="qza" label="${tool.name} on ${on_string}: shuffled_groups.qza" from_work_dir="shuffled_groups.qza"/>
    </outputs>
    <tests/>
    <help>
QIIME 2: metadata shuffle-groups
================================
Shuffle values in a categorical sample metadata column.


Outputs:
--------
:shuffled_groups.qza: Randomized metadata columns

|  

Description:
------------
Create one or more categorical sample metadata columns by shuffling the values in an input metadata column. To avoid confusion, the column name and values will be derived from the provided prefixes. The number of different values (or groups), and the counts of each value, will match the input metadata column but the association of values with sample ids will be random. These data will be written to an artifact that can be used as sample metadata.


|  

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