annotate qiime2/qiime_composition_ancom.xml @ 15:276ec629f09a draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:56:05 +0000
parents a0a8d77a991c
children
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" ?>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
2 <tool id="qiime_composition_ancom" name="qiime composition ancom"
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
3 version="2020.8">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
4 <description>Apply ANCOM to identify features that differ in abundance.</description>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
5 <requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
7 </requirements>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
8 <command><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9 qiime composition ancom
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
12 # if $input_files_mmetadatafile:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
13 # def list_dict_to_string(list_dict):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
15 # for d in list_dict[1:]:
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
17 # end for
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
18 # return $file_list
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
19 # end def
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
21 # end if
6
florianbegusch
parents: 2
diff changeset
22
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
23 #if '__ob__' in str($mmetadatacolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
24 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__ob__', '[')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
25 #set $mmetadatacolumn = $mmetadatacolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
26 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
27 #if '__cb__' in str($mmetadatacolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
28 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__cb__', ']')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
29 #set $mmetadatacolumn = $mmetadatacolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
30 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
31 #if 'X' in str($mmetadatacolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
32 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('X', '\\')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
33 #set $mmetadatacolumn = $mmetadatacolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
34 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
35 #if '__sq__' in str($mmetadatacolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
36 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__sq__', "'")
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
37 #set $mmetadatacolumn = $mmetadatacolumn_temp
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
38 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
39 #if '__db__' in str($mmetadatacolumn):
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
40 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__db__', '"')
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
41 #set $mmetadatacolumn = $mmetadatacolumn_temp
2
51025741f326 Uploaded
florianbegusch
parents: 0
diff changeset
42 #end if
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
44 --m-metadata-column=$mmetadatacolumn
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($ptransformfunction) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 --p-transform-function=$ptransformfunction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
51 #if str($pdifferencefunction) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
52 --p-difference-function=$pdifferencefunction
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
53 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
54
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
55 --o-visualization=ovisualization
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
57 #if str($examples) != 'None':
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
58 --examples=$examples
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
59 #end if
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
60
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
61 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
62 cp ocompositiontable.qza $ocompositiontable
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
63
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
64 ;
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
65 qiime tools export ovisualization.qzv --output-path out
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
66 && mkdir -p '$ovisualization.files_path'
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 && mv '$ovisualization.files_path/index.html' '$ovisualization'
6
florianbegusch
parents: 2
diff changeset
69
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
70 ]]></command>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
71 <inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
72 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Composition] The feature table to be used for ANCOM computation. [required]" name="itable" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
73 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
74 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA" name="additional_input" optional="True" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
75 </repeat>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
76 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] The categorical sample metadata column to test for differential abundance across. [required]" name="mmetadatacolumn" optional="False" type="text" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
77 <param label="--p-transform-function: " name="ptransformfunction" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
78 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
79 <option value="sqrt">sqrt</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
80 <option value="log">log</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
81 <option value="clr">clr</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
82 </param>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
83 <param label="--p-difference-function: " name="pdifferencefunction" optional="True" type="select">
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
84 <option selected="True" value="None">Selection is Optional</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
85 <option value="mean_difference">mean_difference</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
86 <option value="f_statistic">f_statistic</option>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
87 </param>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
88 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
89
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
90 </inputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
91
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
92 <outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
93 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
94
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
95 </outputs>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
96
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
97 <help><![CDATA[
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 Apply ANCOM to identify features that differ in abundance.
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
99 ###############################################################
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 Apply Analysis of Composition of Microbiomes (ANCOM) to identify features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 that are differentially abundant across groups.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
104 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
105 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
106 table : FeatureTable[Composition]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
107 The feature table to be used for ANCOM computation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
108 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
109 The categorical sample metadata column to test for differential
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
110 abundance across.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
111 transform_function : Str % Choices('sqrt', 'log', 'clr'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
112 The method applied to transform feature values before generating
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
113 volcano plots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
114 difference_function : Str % Choices('mean_difference', 'f_statistic'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
115 The method applied to visualize fold difference in feature abundances
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
116 across groups for volcano plots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
117
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
118 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
119 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
120 visualization : Visualization
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
121 ]]></help>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
122 <macros>
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
123 <import>qiime_citation.xml</import>
14
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
124 </macros>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
125 <expand macro="qiime_citation"/>
a0a8d77a991c Uploaded
florianbegusch
parents: 9
diff changeset
126 </tool>