annotate qiime2__metadata__distance_matrix.xml @ 2:8a43985a8f35 draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 65e4952f33eb335528e8553150e9097e5ea8f556
author q2d2
date Thu, 08 Jun 2023 19:49:40 +0000
parents a75c3ed80cff
children 873c9175076f
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
2 <!--
1
a75c3ed80cff planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
3 Copyright (c) 2023, QIIME 2 development team.
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
4
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
6 -->
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
7 <!--
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
8 This tool was automatically generated by:
2
8a43985a8f35 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 65e4952f33eb335528e8553150e9097e5ea8f556
q2d2
parents: 1
diff changeset
9 q2galaxy (version: 2023.5.0)
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
10 for:
2
8a43985a8f35 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 65e4952f33eb335528e8553150e9097e5ea8f556
q2d2
parents: 1
diff changeset
11 qiime2 (version: 2023.5.1)
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
12 -->
2
8a43985a8f35 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 65e4952f33eb335528e8553150e9097e5ea8f556
q2d2
parents: 1
diff changeset
13 <tool name="qiime2 metadata distance-matrix" id="qiime2__metadata__distance_matrix" version="2023.5.0+q2galaxy.2023.5.0.2" profile="22.05" license="BSD-3-Clause">
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
14 <description>Create a distance matrix from a numeric Metadata column</description>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
15 <requirements>
2
8a43985a8f35 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 65e4952f33eb335528e8553150e9097e5ea8f556
q2d2
parents: 1
diff changeset
16 <container type="docker">quay.io/qiime2/core:2023.5</container>
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
17 </requirements>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
18 <version_command>q2galaxy version metadata</version_command>
1
a75c3ed80cff planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
19 <command detect_errors="exit_code">q2galaxy run metadata distance_matrix '$inputs'</command>
0
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
20 <configfiles>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
21 <inputs name="inputs" data_style="paths"/>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
22 </configfiles>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
23 <inputs>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
24 <conditional name="metadata">
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
25 <param name="type" type="select" label="metadata: MetadataColumn[Numeric]" help="[required] Numeric metadata column to compute pairwise Euclidean distances from">
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
26 <option value="tsv" selected="true">Metadata from TSV</option>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
27 <option value="qza">Metadata from Artifact</option>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
28 </param>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
29 <when value="tsv">
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
30 <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
31 <param name="column" type="data_column" label="Column Name" data_ref="source" use_header_names="true">
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
32 <validator type="expression" message="The first column cannot be selected (they are IDs).">value != "1"</validator>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
33 </param>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
34 </when>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
35 <when value="qza">
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
36 <param name="source" type="data" format="qza" label="Metadata Source"/>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
37 <param name="column" type="text" label="Column Name">
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
38 <validator type="empty_field"/>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
39 </param>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
40 </when>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
41 </conditional>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
42 </inputs>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
43 <outputs>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
44 <data name="distance_matrix" format="qza" label="${tool.name} on ${on_string}: distance_matrix.qza" from_work_dir="distance_matrix.qza"/>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
45 </outputs>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
46 <tests/>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
47 <help>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
48 QIIME 2: metadata distance-matrix
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
49 =================================
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
50 Create a distance matrix from a numeric Metadata column
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
51
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
52
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
53 Outputs:
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
54 --------
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
55 :distance_matrix.qza: &lt;no description&gt;
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
56
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
57 |
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
58
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
59 Description:
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
60 ------------
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
61 Create a distance matrix from a numeric metadata column. The Euclidean distance is computed between each pair of samples or features in the column.
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
62
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
63 Tip: the distance matrix produced by this method can be used as input to the Mantel test available in `q2-diversity`.
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
64
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
65
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
66 |
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
67
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
68 </help>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
69 <citations>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
70 <citation type="doi">10.1038/s41587-019-0209-9</citation>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
71 </citations>
c6f80266af38 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__metadata commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
72 </tool>