annotate qiime2/qiime_longitudinal_nmit.xml @ 4:914fa4daf16a draft

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