annotate qiime_longitudinal_nmit.xml @ 1:f2028d8efed6 draft default tip

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