Mercurial > repos > q2d2 > qiime2__longitudinal__plot_feature_volatility

comparison qiime2__longitudinal__plot_feature_volatility.xml @ 0:288bbd29e931 draft

Find changesets by keywords (author, files, the commit message), revision number or hash, or revset expression.
planemo upload for repository https://github.com/qiime2/galaxy-tools/tree/main/tools/suite_qiime2__longitudinal commit 9023cfd83495a517fbcbb6f91d5b01a6f1afcda1
author q2d2
date Mon, 29 Aug 2022 20:08:37 +0000
parents
children 1a9474d0391a
comparison
equal deleted inserted replaced
-1:000000000000 0:288bbd29e931
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 longitudinal plot-feature-volatility" id="qiime2__longitudinal__plot_feature_volatility" version="2022.8.0+q2galaxy.2022.8.1.2" profile="22.05" license="BSD-3-Clause">
14 <description>Plot longitudinal feature volatility and importances</description>
15 <requirements>
16 <container type="docker">quay.io/qiime2/core:2022.8</container>
17 </requirements>
18 <version_command>q2galaxy version longitudinal</version_command>
19 <command detect_errors="aggressive">q2galaxy run longitudinal plot_feature_volatility '$inputs'</command>
20 <configfiles>
21 <inputs name="inputs" data_style="paths"/>
22 </configfiles>
23 <inputs>
24 <param name="table" type="data" format="qza" label="table: FeatureTable[RelativeFrequency]" help="[required] Feature table containing features found in importances.">
25 <options options_filter_attribute="metadata.semantic_type">
26 <filter type="add_value" value="FeatureTable[RelativeFrequency]"/>
27 </options>
28 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureTable[RelativeFrequency]']</validator>
29 </param>
30 <param name="importances" type="data" format="qza" label="importances: FeatureData[Importance]" help="[required] Feature importance scores.">
31 <options options_filter_attribute="metadata.semantic_type">
32 <filter type="add_value" value="FeatureData[Importance]"/>
33 </options>
34 <validator type="expression" message="Incompatible type">hasattr(value.metadata, "semantic_type") and value.metadata.semantic_type in ['FeatureData[Importance]']</validator>
35 </param>
36 <repeat name="metadata" min="1" help="[required] Sample metadata file containing individual_id_column." title="metadata: Metadata">
37 <conditional name="__q2galaxy__GUI__conditional__metadata__">
38 <param name="type" type="select" label="metadata: Metadata">
39 <option value="tsv" selected="true">Metadata from TSV</option>
40 <option value="qza">Metadata from Artifact</option>
41 </param>
42 <when value="tsv">
43 <param name="source" type="data" format="tabular,qiime2.tabular" label="Metadata Source"/>
44 </when>
45 <when value="qza">
46 <param name="source" type="data" format="qza" label="Metadata Source"/>
47 </when>
48 </conditional>
49 </repeat>
50 <param name="state_column" type="text" label="state_column: Str" help="[required] Metadata column containing state (time) variable information.">
51 <sanitizer>
52 <valid initial="string.printable"/>
53 </sanitizer>
54 <validator type="expression" message="Please verify this parameter.">value is not None and len(value) &gt; 0</validator>
55 </param>
56 <section name="__q2galaxy__GUI__section__extra_opts__" title="Click here for additional options">
57 <conditional name="__q2galaxy__GUI__conditional__individual_id_column__" label="individual_id_column: Str">
58 <param name="__q2galaxy__GUI__select__" type="select" label="individual_id_column: Str" help="[optional] Metadata column containing IDs for individual subjects.">
59 <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option>
60 <option value="__q2galaxy__::control::provide">Provide a value</option>
61 </param>
62 <when value="__q2galaxy__::control::default">
63 <param name="individual_id_column" type="hidden" value="__q2galaxy__::literal::None"/>
64 </when>
65 <when value="__q2galaxy__::control::provide">
66 <param name="individual_id_column" type="text">
67 <sanitizer>
68 <valid initial="string.printable"/>
69 </sanitizer>
70 </param>
71 </when>
72 </conditional>
73 <conditional name="__q2galaxy__GUI__conditional__default_group_column__" label="default_group_column: Str">
74 <param name="__q2galaxy__GUI__select__" type="select" label="default_group_column: Str" help="[optional] The default metadata column on which to separate groups for comparison (all categorical metadata columns will be available in the visualization).">
75 <option value="__q2galaxy__::control::default" selected="true">None (Use default behavior)</option>
76 <option value="__q2galaxy__::control::provide">Provide a value</option>
77 </param>
78 <when value="__q2galaxy__::control::default">
79 <param name="default_group_column" type="hidden" value="__q2galaxy__::literal::None"/>
80 </when>
81 <when value="__q2galaxy__::control::provide">
82 <param name="default_group_column" type="text">
83 <sanitizer>
84 <valid initial="string.printable"/>
85 </sanitizer>
86 </param>
87 </when>
88 </conditional>
89 <param name="yscale" type="select" label="yscale: Str % Choices('linear', 'pow', 'sqrt', 'log')" display="radio">
90 <option value="linear" selected="true">linear</option>
91 <option value="pow">pow</option>
92 <option value="sqrt">sqrt</option>
93 <option value="log">log</option>
94 </param>
95 <conditional name="__q2galaxy__GUI__conditional__importance_threshold__">
96 <param name="__q2galaxy__GUI__select__" type="select" label="importance_threshold: Float % Range(0, None, inclusive_start=False) | Str % Choices('q1', 'q2', 'q3')" help="[optional] Filter feature table to exclude any features with an importance score less than this threshold. Set to &quot;q1&quot;, &quot;q2&quot;, or &quot;q3&quot; to select the first, second, or third quartile of values. Set to &quot;None&quot; to disable this filter.">
97 <option value="__q2galaxy__::literal::None" selected="true">None (Use default behavior)</option>
98 <option value="q1">q1 (Str)</option>
99 <option value="q2">q2 (Str)</option>
100 <option value="q3">q3 (Str)</option>
101 <option value="__q2galaxy__::control::Float X Range(0__comma__ None__comma__ inclusive_start=False)">Provide a value (Float % Range(0, None, inclusive_start=False))</option>
102 </param>
103 <when value="__q2galaxy__::literal::None">
104 <param name="importance_threshold" type="hidden" value="__q2galaxy__::literal::None"/>
105 </when>
106 <when value="q1">
107 <param name="importance_threshold" type="hidden" value="q1"/>
108 </when>
109 <when value="q2">
110 <param name="importance_threshold" type="hidden" value="q2"/>
111 </when>
112 <when value="q3">
113 <param name="importance_threshold" type="hidden" value="q3"/>
114 </when>
115 <when value="__q2galaxy__::control::Float X Range(0__comma__ None__comma__ inclusive_start=False)">
116 <param name="importance_threshold" type="float" min="1e-06" value="" label="importance_threshold: Float % Range(0, None, inclusive_start=False)" help="[required] Filter feature table to exclude any features with an importance score less than this threshold. Set to &quot;q1&quot;, &quot;q2&quot;, or &quot;q3&quot; to select the first, second, or third quartile of values. Set to &quot;None&quot; to disable this filter."/>
117 </when>
118 </conditional>
119 <conditional name="__q2galaxy__GUI__conditional__feature_count__">
120 <param name="__q2galaxy__GUI__select__" type="select" label="feature_count: Int % Range(1, None) | Str % Choices('all')" help="[default: 100] Filter feature table to include top N most important features. Set to &quot;all&quot; to include all features.">
121 <option value="all">all (Str)</option>
122 <option value="__q2galaxy__::control::Int X Range(1__comma__ None)" selected="true">Provide a value (Int % Range(1, None))</option>
123 </param>
124 <when value="all">
125 <param name="feature_count" type="hidden" value="all"/>
126 </when>
127 <when value="__q2galaxy__::control::Int X Range(1__comma__ None)">
128 <param name="feature_count" type="integer" min="1" value="100" label="feature_count: Int % Range(1, None)" help="[default: 100] Filter feature table to include top N most important features. Set to &quot;all&quot; to include all features."/>
129 </when>
130 </conditional>
131 <param name="missing_samples" type="select" label="missing_samples: Str % Choices('error', 'ignore')" display="radio">
132 <option value="error" selected="true">error</option>
133 <option value="ignore">ignore</option>
134 </param>
135 </section>
136 </inputs>
137 <outputs>
138 <data name="visualization" format="qzv" label="${tool.name} on ${on_string}: visualization.qzv" from_work_dir="visualization.qzv"/>
139 </outputs>
140 <tests/>
141 <help>
142 QIIME 2: longitudinal plot-feature-volatility
143 =============================================
144 Plot longitudinal feature volatility and importances
145
146
147 Outputs:
148 --------
149 :visualization.qzv: &lt;no description&gt;
150
151 |
152
153 Description:
154 ------------
155 Plots an interactive control chart of feature abundances (y-axis) in each sample across time (or state; x-axis). Feature importance scores and descriptive statistics for each feature are plotted in interactive bar charts below the control chart, facilitating exploration of longitudinal feature data. This visualization is intended for use with the feature-volatility pipeline; use that pipeline to access this visualization.
156
157
158 |
159
160 </help>
161 <citations>
162 <citation type="doi">10.1128/mSystems.00219-18</citation>
163 <citation type="doi">10.1038/s41587-019-0209-9</citation>
164 </citations>
165 </tool>