annotate qiime2/qiime_composition_ancom.xml @ 0:370e0b6e9826 draft

Uploaded
author florianbegusch
date Wed, 17 Jul 2019 03:05:17 -0400
parents
children 51025741f326
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_composition_ancom" name="qiime composition ancom" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Apply ANCOM to identify features that differ in abundance.</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 composition ancom
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = $file_list + ',' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile) --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #if str($pdifferencefunction) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-difference-function=$pdifferencefunction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if str($ptransformfunction) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-transform-function=$ptransformfunction
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --o-visualization=ovisualization;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 qiime tools export --input-path ovisualization.qzv --output-path out && mkdir -p '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 && cp -r out/* '$ovisualization.files_path'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 && mv '$ovisualization.files_path/index.html' '$ovisualization'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <param label="--p-difference-function: " name="pdifferencefunction" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="mean_difference">mean_difference</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="f_statistic">f_statistic</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <param label="--p-transform-function: " name="ptransformfunction" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="log">log</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <option value="clr">clr</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="sqrt">sqrt</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 Apply ANCOM to identify features that differ in abundance.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 ##########################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 Apply Analysis of Composition of Microbiomes (ANCOM) to identify features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 that are differentially abundant across groups.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 table : FeatureTable[Composition]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 The feature table to be used for ANCOM computation.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 The categorical sample metadata column to test for differential
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 abundance across.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 transform_function : Str % Choices('sqrt', 'log', 'clr'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 The method applied to transform feature values before generating
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 volcano plots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 difference_function : Str % Choices('mean_difference', 'f_statistic'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 The method applied to visualize fold difference in feature abundances
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 across groups for volcano plots.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 visualization : Visualization
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 </tool>