annotate qiime2__diversity__bioenv.xml @ 7:897ac0a07708 draft default tip

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
author q2d2
date Tue, 15 Jul 2025 21:50:31 +0000
parents 56a0004016a9
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
1 <?xml version='1.0' encoding='utf-8'?>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
2 <!--
6
56a0004016a9 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit b1fccfb38b4873cd4699743033449014a2978e7d
q2d2
parents: 5
diff changeset
3 Copyright (c) 2025, QIIME 2 development team.
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
4
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
6 -->
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
7 <!--
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
8 This tool was automatically generated by:
7
897ac0a07708 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
9 q2galaxy (version: 2025.7.0)
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
10 for:
7
897ac0a07708 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
11 qiime2 (version: 2025.7.0)
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
12 -->
7
897ac0a07708 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
13 <tool name="qiime2 diversity bioenv" id="qiime2__diversity__bioenv" version="2025.7.0+q2galaxy.2025.7.0" profile="22.05" license="BSD-3-Clause">
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
14 <description>bioenv</description>
5
21ca3e4d0f06 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
15 <xrefs>
21ca3e4d0f06 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
16 <xref type="bio.tools">qiime2</xref>
21ca3e4d0f06 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 5f71b597c9495eae67a447744fded834f56ca1f7
q2d2
parents: 4
diff changeset
17 </xrefs>
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
18 <requirements>
7
897ac0a07708 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9436cc47c72b58a6a3d3a5c2ee075689c2926ef0
q2d2
parents: 6
diff changeset
19 <container type="docker">quay.io/qiime2/amplicon:2025.7</container>
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
20 </requirements>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
21 <version_command>q2galaxy version diversity</version_command>
1
0f90022f70de planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 69da7976573cc07a363ac66bdacc9269d7cd3732
q2d2
parents: 0
diff changeset
22 <command detect_errors="exit_code">q2galaxy run diversity bioenv '$inputs'</command>
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
23 <configfiles>
3
df846bfc8b5e planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 389df0134cd0763dcf02aac6e623fc15f8861c1e
q2d2
parents: 2
diff changeset
24 <inputs name="inputs" data_style="staging_path_and_source_path"/>
0
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
25 </configfiles>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
26 <inputs>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
27 <param name="distance_matrix" type="data" format="qza" label="distance_matrix: DistanceMatrix" help="[required] Matrix of distances between pairs of samples.">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
28 <options options_filter_attribute="metadata.semantic_type">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
29 <filter type="add_value" value="DistanceMatrix"/>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
30 </options>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
31 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['DistanceMatrix']</validator>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
32 </param>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
33 <repeat name="metadata" min="1" help="[required] The sample metadata." title="metadata: Metadata">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
34 <conditional name="__q2galaxy__GUI__conditional__metadata__">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
35 <param name="type" type="select" label="metadata: Metadata">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
36 <option value="tsv" selected="true">Metadata from TSV</option>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
37 <option value="qza">Metadata from Artifact</option>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
38 </param>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
39 <when value="tsv">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
40 <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
41 </when>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
42 <when value="qza">
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
43 <param name="source" type="data" format="qza" label="Metadata Source"/>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
44 </when>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
45 </conditional>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
46 </repeat>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
47 </inputs>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
48 <outputs>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
49 <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
50 </outputs>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
51 <tests/>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
52 <help>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
53 QIIME 2: diversity bioenv
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
54 =========================
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
55 bioenv
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
56
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
57
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
58 Outputs:
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
59 --------
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
60 :visualization.qzv: &lt;no description&gt;
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
61
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
62 |
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
63
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
64 Description:
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
65 ------------
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
66 Find the subsets of variables in metadata whose Euclidean distances are maximally rank-correlated with distance matrix. All numeric variables in metadata will be considered, and samples which are missing data will be dropped. The output visualization will indicate how many samples were dropped due to missing data, if any were dropped.
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
67
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
68
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
69 |
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
70
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
71 </help>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
72 <citations>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
73 <citation type="doi">https://doi.org/10.3354/meps092205</citation>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
74 <citation type="doi">10.1038/s41587-019-0209-9</citation>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
75 </citations>
235730f21d91 planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__diversity commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
q2d2
parents:
diff changeset
76 </tool>