annotate qiime2/qiime_longitudinal_volatility.xml @ 7:85b520815e85 draft

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