annotate qiime2/qiime_composition_ancom.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_composition_ancom" name="qiime composition ancom" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Apply ANCOM to identify features that differ in abundance.</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><![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
8
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
9 qiime composition ancom --i-table=$itable
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 + ',' + 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) --m-metadata-column="$mmetadatacolumn"
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
20
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($pdifferencefunction) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 --p-difference-function=$pdifferencefunction
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($cmdconfig) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 --cmd-config=$cmdconfig
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 #if str($ptransformfunction) != 'None':
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 --p-transform-function=$ptransformfunction
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 --o-visualization=ovisualization;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 qiime tools export ovisualization.qzv --output-dir out && mkdir -p '$ovisualization.files_path'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 && cp -r out/* '$ovisualization.files_path'
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 && mv '$ovisualization.files_path/index.html' '$ovisualization';
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 ]]></command>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 <inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Composition] - The feature table to be used for ANCOM computation. [required]" name="itable" optional="False" type="data"/>
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 format="tabular" label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [required]" name="additional_input" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 </repeat>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45 <param label="--m-metadata-column: MetadataColumn[Categorical] - Column from metadata file or artifact viewable as metadata. The categorical sample metadata column to test for differential abundance across. [required]" name="mmetadatacolumn" optional="False" type="text"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 <param label="--p-difference-function: " name="pdifferencefunction" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 <option selected="True" value="None">Selection is Optional</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 <option value="mean_difference">mean_difference</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="f_statistic">f_statistic</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-transform-function: " name="ptransformfunction" optional="True" type="select">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53 <option selected="True" value="None">Selection is Optional</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="log">log</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="clr">clr</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
56 <option value="sqrt">sqrt</option>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
57 </param>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
58 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
59 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
60 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
61 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
62 <help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
63 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
64 Apply ANCOM to identify features that differ in abundance.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
65 ----------------------------------------------------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
66
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
67 Apply Analysis of Composition of Microbiomes (ANCOM) to identify features
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
68 that are differentially abundant across groups.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
69
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
70 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
71 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
72 table : FeatureTable[Composition]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
73 The feature table to be used for ANCOM computation.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
74 metadata : MetadataColumn[Categorical]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
75 The categorical sample metadata column to test for differential
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
76 abundance across.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
77 transform_function : Str % Choices({'clr', 'log', 'sqrt'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
78 The method applied to transform feature values before generating
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
79 volcano plots.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
80 difference_function : Str % Choices({'f_statistic', 'mean_difference'}), optional
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
81 The method applied to visualize fold difference in feature abundances
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
82 across groups for volcano plots.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
83
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
84 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
85 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
86 visualization : Visualization
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
87
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
88 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
89 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
90 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
91 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
92 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
93 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
94 </tool>