annotate qiime_metadata_distance-matrix.xml @ 0:09b7bcb72fa7 draft

Uploaded
author florianbegusch
date Thu, 24 May 2018 02:11:44 -0400
parents
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_metadata_distance-matrix" name="qiime metadata distance-matrix" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Create a distance matrix from a numeric Metadata column</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 metadata distance-matrix --m-metadata-column="$mmetadatacolumn"
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 + ' --m-metadata-file=' + 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)
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 --o-distance-matrix=odistancematrix;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 cp odistancematrix.qza $odistancematrix;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 </command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 <param 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" format="tabular,qza,no_unzip.zip" />
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 </repeat>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 <param label="--m-metadata-column: MetadataColumn[Numeric] Column from metadata file or artifact viewable as metadata. Numeric metadata column to compute pairwise Euclidean distances from [required]" name="mmetadatacolumn" optional="False" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 <data format="qza" label="${tool.name} on ${on_string}: distance-matrix.qza" name="odistancematrix"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 <help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 Create a distance matrix from a numeric Metadata column
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 --------------------------------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 Create a distance matrix from a numeric metadata column. The Euclidean
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 distance is computed between each pair of samples or features in the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 column. Tip: the distance matrix produced by this method can be used as
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 input to the Mantel test available in `q2-diversity`.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 metadata : MetadataColumn[Numeric]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 Numeric metadata column to compute pairwise Euclidean distances from
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 distance_matrix : DistanceMatrix
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 \
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 </tool>