annotate qiime2__metadata__distance_matrix.xml @ 0:c6f80266af38 draft

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

<?xml version='1.0' encoding='utf-8'?>
<!--
Copyright (c) 2022, 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: 2022.8.1)
for:
    qiime2 (version: 2022.8.1)
-->
<tool name="qiime2 metadata distance-matrix" id="qiime2__metadata__distance_matrix" version="2022.8.0+q2galaxy.2022.8.1.2" profile="22.05" license="BSD-3-Clause">
    <description>Create a distance matrix from a numeric Metadata column</description>
    <requirements>
        <container type="docker">quay.io/qiime2/core:2022.8</container>
    </requirements>
    <version_command>q2galaxy version metadata</version_command>
    <command detect_errors="aggressive">q2galaxy run metadata distance_matrix '$inputs'</command>
    <configfiles>
        <inputs name="inputs" data_style="paths"/>
    </configfiles>
    <inputs>
        <conditional name="metadata">
            <param name="type" type="select" label="metadata: MetadataColumn[Numeric]" help="[required]  Numeric metadata column to compute pairwise Euclidean distances from">
                <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>
    </inputs>
    <outputs>
        <data name="distance_matrix" format="qza" label="${tool.name} on ${on_string}: distance_matrix.qza" from_work_dir="distance_matrix.qza"/>
    </outputs>
    <tests/>
    <help>
QIIME 2: metadata distance-matrix
=================================
Create a distance matrix from a numeric Metadata column


Outputs:
--------
:distance_matrix.qza: &lt;no description&gt;

|  

Description:
------------
Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.

Tip: the distance matrix produced by this method can be used as input to the Mantel test available in `q2-diversity`.


|  

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