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

Uploaded
author florianbegusch
date Wed, 17 Jul 2019 03:05:17 -0400
parents
children 914fa4daf16a
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_longitudinal_nmit" name="qiime longitudinal nmit" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Nonparametric microbial interdependence test</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 longitudinal nmit
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --p-individual-id-column="$pindividualidcolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #if str($pcorrmethod) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 --p-corr-method=$pcorrmethod
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #if str($pdistmethod) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --p-dist-method=$pdistmethod
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 --o-distance-matrix=odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 cp odistancematrix.qza $odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <param label="--p-individual-id-column: TEXT Metadata column containing IDs for individual subjects. [required]" name="pindividualidcolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <param label="--p-corr-method: " name="pcorrmethod" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 <option value="kendall">kendall</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <option value="pearson">pearson</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <option value="spearman">spearman</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 <param label="--p-dist-method: " name="pdistmethod" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 <option value="fro">fro</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <option value="nuc">nuc</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <param label="--m-metadata-file: Metadata file or artifact viewable as metadata. This option may be supplied multiple times to merge metadata. [optional]" name="additional_input" type="data" format="tabular,qza,no_unzip.zip" />
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 Nonparametric microbial interdependence test
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 ############################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 Perform nonparametric microbial interdependence test to determine
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 longitudinal sample similarity as a function of temporal microbial
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 composition. For more details and citation, please see
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 doi.org/10.1002/gepi.22065
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 table : FeatureTable[RelativeFrequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 Feature table to use for microbial interdependence test.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 metadata : Metadata
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 Sample metadata file containing individual_id_column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 individual_id_column : Str
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Metadata column containing IDs for individual subjects.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 corr_method : Str % Choices('kendall', 'pearson', 'spearman'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 The temporal correlation test to be applied.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 dist_method : Str % Choices('fro', 'nuc'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 Temporal distance method, see numpy.linalg.norm for details.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 The resulting distance matrix.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 </tool>