comparison qiime2__emperor__plot.xml @ 0:e6978c621d70 draft

planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__emperor commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
author q2d2
date Mon, 29 Aug 2022 19:49:22 +0000
parents
children 7c9ec8b8b7f8
comparison
equal deleted inserted replaced
-1:000000000000 0:e6978c621d70
1 <?xml version='1.0' encoding='utf-8'?>
2 <!--
3 Copyright (c) 2022, QIIME 2 development team.
4
5 Distributed under the terms of the Modified BSD License. (SPDX: BSD-3-Clause)
6 -->
7 <!--
8 This tool was automatically generated by:
9 q2galaxy (version: 2022.8.1)
10 for:
11 qiime2 (version: 2022.8.1)
12 -->
13 <tool name="qiime2 emperor plot" id="qiime2__emperor__plot" version="2022.8.0+q2galaxy.2022.8.1.2" profile="22.05" license="BSD-3-Clause">
14 <description>Visualize and Interact with Principal Coordinates Analysis Plots</description>
15 <requirements>
16 <container type="docker">quay.io/qiime2/core:2022.8</container>
17 </requirements>
18 <version_command>q2galaxy version emperor</version_command>
19 <command detect_errors="aggressive">q2galaxy run emperor plot '$inputs'</command>
20 <configfiles>
21 <inputs name="inputs" data_style="paths"/>
22 </configfiles>
23 <inputs>
24 <param name="pcoa" type="data" format="qza" label="pcoa: PCoAResults" help="[required] The principal coordinates matrix to be plotted.">
25 <options options_filter_attribute="metadata.semantic_type">
26 <filter type="add_value" value="PCoAResults"/>
27 </options>
28 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['PCoAResults']</validator>
29 </param>
30 <repeat name="metadata" min="1" help="[required] The sample metadata." title="metadata: Metadata">
31 <conditional name="__q2galaxy__GUI__conditional__metadata__">
32 <param name="type" type="select" label="metadata: Metadata">
33 <option value="tsv" selected="true">Metadata from TSV</option>
34 <option value="qza">Metadata from Artifact</option>
35 </param>
36 <when value="tsv">
37 <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
38 </when>
39 <when value="qza">
40 <param name="source" type="data" format="qza" label="Metadata Source"/>
41 </when>
42 </conditional>
43 </repeat>
44 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
45 <repeat name="custom_axes" help="[optional] Numeric sample metadata columns that should be included as axes in the Emperor plot." title="custom_axes: List[Str]">
46 <param name="element" type="text" label="element: Str" help="[required]">
47 <sanitizer>
48 <valid initial="string.printable"/>
49 </sanitizer>
50 <validator type="expression" message="Please verify this parameter.">value is not None and len(value) &gt; 0</validator>
51 </param>
52 </repeat>
53 <param name="ignore_missing_samples" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="ignore_missing_samples: Bool" help="[default: No] This will suppress the error raised when the coordinates matrix contains samples that are not present in the metadata. Samples without metadata are included by setting all metadata values to: &quot;This sample has no metadata&quot;. This flag is only applied if at least one sample is present in both the coordinates matrix and the metadata."/>
54 <param name="ignore_pcoa_features" type="boolean" truevalue="__q2galaxy__::literal::True" falsevalue="__q2galaxy__::literal::False" label="ignore_pcoa_features: Bool" help="[default: No] Biplot arrows cannot be visualized using this method. If you want to visualize biplot arrows use the `biplot` method. Enabling this setting will ignore any PCoA features that are present, otherwise, if PCoA features are detected an error will be raised."/>
55 </section>
56 </inputs>
57 <outputs>
58 <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
59 </outputs>
60 <tests/>
61 <help>
62 QIIME 2: emperor plot
63 =====================
64 Visualize and Interact with Principal Coordinates Analysis Plots
65
66
67 Outputs:
68 --------
69 :visualization.qzv: &lt;no description&gt;
70
71 |
72
73 Description:
74 ------------
75 Generates an interactive ordination plot where the user can visually integrate sample metadata.
76
77
78 |
79
80 </help>
81 <citations>
82 <citation type="doi">10.1186/2047-217X-2-16</citation>
83 <citation type="doi">10.1016/j.chom.2016.12.009</citation>
84 <citation type="doi">10.1038/s41587-019-0209-9</citation>
85 </citations>
86 </tool>