annotate qiime2/qiime_longitudinal_nmit.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_longitudinal_nmit" name="qiime longitudinal nmit"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Nonparametric microbial interdependence test</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime longitudinal nmit
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12 # if $input_files_mmetadatafile:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 # def list_dict_to_string(list_dict):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 # for d in list_dict[1:]:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 # end for
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 # return $file_list
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 # end def
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 # end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 #if '__ob__' in str($pindividualidcolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__ob__', '[')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #set $pindividualidcolumn = $pindividualidcolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 #if '__cb__' in str($pindividualidcolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__cb__', ']')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 #set $pindividualidcolumn = $pindividualidcolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 #if 'X' in str($pindividualidcolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('X', '\\')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 #set $pindividualidcolumn = $pindividualidcolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 #if '__sq__' in str($pindividualidcolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__sq__', "'")
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 #set $pindividualidcolumn = $pindividualidcolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 #if '__db__' in str($pindividualidcolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 #set $pindividualidcolumn_temp = $pindividualidcolumn.replace('__db__', '"')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 #set $pindividualidcolumn = $pindividualidcolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 --p-individual-id-column=$pindividualidcolumn
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 #if str($pcorrmethod) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48 --p-corr-method=$pcorrmethod
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 #if str($pdistmethod) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 --p-dist-method=$pdistmethod
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 --o-distance-matrix=odistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 cp odistancematrix.qza $odistancematrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[RelativeFrequency] Feature table to use for microbial interdependence test. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple Sample metadata file containing individual-id-column. arguments will be merged) [required]" name="additional_input" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 </repeat>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--p-individual-id-column: TEXT Metadata column containing IDs for individual subjects. [required]" name="pindividualidcolumn" optional="False" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-corr-method: " name="pcorrmethod" optional="True" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 <option selected="True" value="None">Selection is Optional</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="kendall">kendall</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="pearson">pearson</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 <option value="spearman">spearman</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 <param label="--p-dist-method: " name="pdistmethod" optional="True" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 <option selected="True" value="None">Selection is Optional</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 <option value="fro">fro</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 <option value="nuc">nuc</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 Nonparametric microbial interdependence test
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 Perform nonparametric microbial interdependence test to determine
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96 longitudinal sample similarity as a function of temporal microbial
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 composition. For more details and citation, please see
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 doi.org/10.1002/gepi.22065
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102 table : FeatureTable[RelativeFrequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 Feature table to use for microbial interdependence test.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 metadata : Metadata
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105 Sample metadata file containing individual_id_column.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
106 individual_id_column : Str
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
107 Metadata column containing IDs for individual subjects.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
108 corr_method : Str % Choices('kendall', 'pearson', 'spearman'), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
109 The temporal correlation test to be applied.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
110 dist_method : Str % Choices('fro', 'nuc'), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
111 Temporal distance method, see numpy.linalg.norm for details.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
112
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
113 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
114 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
115 distance_matrix : DistanceMatrix
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
116 The resulting distance matrix.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
117 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
118 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
119 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
120 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
121 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
122 </tool>