annotate qiime2/qiime_longitudinal_volatility.xml @ 0:51b9b6b57732 draft

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