annotate qiime2/qiime_longitudinal_plot-feature-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_plot-feature-volatility" name="qiime longitudinal plot-feature-volatility" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Plot longitudinal feature volatility and importances</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 plot-feature-volatility
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-importances=$iimportances
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --p-state-column="$pstatecolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #if str($pindividualidcolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #if str($pdefaultgroupcolumn):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --p-default-group-column="$pdefaultgroupcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #if str($pyscale) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-yscale=$pyscale
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-visualization=ovisualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table containing features found in importances. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <param format="qza,no_unzip.zip" label="--i-importances: ARTIFACT FeatureData[Importance] Feature importance scores. [required]" name="iimportances" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <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
49 <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
50 <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
51 <param label="--p-yscale: " name="pyscale" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="linear">linear</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="pow">pow</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="sqrt">sqrt</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="log">log</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <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
61 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 Plot longitudinal feature volatility and importances
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 ####################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 Plots an interactive control chart of feature abundances (y-axis) in each
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 sample across time (or state; x-axis). Feature importance scores and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 descriptive statistics for each each feature are plotted in interactive bar
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 charts below the control chart, facilitating exploration of longitudinal
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 feature data. This visualization is intended for use with the feature-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 volatility pipeline; use that pipeline to access this visualization.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 table : FeatureTable[RelativeFrequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Feature table containing features found in importances.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 importances : FeatureData[Importance]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Feature importance scores.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 state_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 Metadata column containing state (time) variable information.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 individual_id_column : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 default_group_column : Str, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 The default metadata column on which to separate groups for comparison
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 (all categorical metadata columns will be available in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 visualization).
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 yscale : Str % Choices('linear', 'pow', 'sqrt', 'log'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 y-axis scaling strategy to apply.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 </tool>