annotate qiime2-2020.8/qiime_composition_ancom.xml @ 20:d93d8888f0b0 draft

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