annotate qiime2/qiime_longitudinal_volatility.xml @ 0:370e0b6e9826 draft

Uploaded
author florianbegusch
date Wed, 17 Jul 2019 03:05:17 -0400
parents
children 914fa4daf16a
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_longitudinal_volatility" name="qiime longitudinal volatility" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Generate interactive volatility plot</description>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2019.4">qiime2</requirement>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
7 <command><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
8 qiime longitudinal volatility
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --p-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 #if str($itable) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #if str($pindividualidcolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #if str($pdefaultgroupcolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --p-default-group-column="$pdefaultgroupcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #if str($pdefaultmetric):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --p-default-metric="$pdefaultmetric"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #if str($pyscale) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 --p-yscale=$pyscale
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 && mv '$ovisualization.files_path/index.html' '$ovisualization';
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-state-column: TEXT Metadata column containing state (time) variable information. [required]" name="pstatecolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table containing metrics. [optional]" name="itable" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--p-individual-id-column: TEXT Metadata column containing IDs for individual subjects. [optional]" name="pindividualidcolumn" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <param label="--p-default-group-column: TEXT The default metadata column on which to separate groups for comparison (all categorical metadata columns will be available in the visualization). [optional]" name="pdefaultgroupcolumn" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <param label="--p-default-metric: TEXT Numeric metadata or artifact column to test by default (all numeric metadata columns will be available in the visualization). [optional]" name="pdefaultmetric" optional="True" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-yscale: " name="pyscale" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="linear">linear</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="pow">pow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="sqrt">sqrt</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="log">log</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 Generate interactive volatility plot
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 ####################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Generate an interactive control chart depicting the longitudinal volatility
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 of sample metadata and/or feature frequencies across time (as set using the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 "state_column" parameter). Any numeric metadata column (and metadata-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 transformable artifacts, e.g., alpha diversity results) can be plotted on
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 the y-axis, and are selectable using the "metric_column" selector. Metric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 values are averaged to compare across any categorical metadata column using
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 the "group_column" selector. Longitudinal volatility for individual
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 subjects sampled over time is co-plotted as "spaghetti" plots if the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 "individual_id_column" parameter is used. state_column will typically be a
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 measure of time, but any numeric metadata column can be used.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 Metadata column containing state (time) variable information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 individual_id_column : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 default_group_column : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 The default metadata column on which to separate groups for comparison
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 (all categorical metadata columns will be available in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 visualization).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 default_metric : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 Numeric metadata or artifact column to test by default (all numeric
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 metadata columns will be available in the visualization).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 table : FeatureTable[RelativeFrequency], optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Feature table containing metrics.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 yscale : Str % Choices('linear', 'pow', 'sqrt', 'log'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 y-axis scaling strategy to apply.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 </tool>