annotate qiime2/qiime_metadata_distance-matrix.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -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_metadata_distance-matrix" name="qiime metadata distance-matrix" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Create a distance matrix from a numeric Metadata column</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 metadata distance-matrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 --o-distance-matrix=odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 cp odistancematrix.qza $odistancematrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 <param label="--m-metadata-column: COLUMN MetadataColumn[Numeric] Numeric metadata column to compute pairwise Euclidean distances from [required]" name="mmetadatacolumn" optional="False" type="text"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <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
34 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <data format="qza" label="${tool.name} on ${on_string}: distancematrix.qza" name="odistancematrix"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 Create a distance matrix from a numeric Metadata column
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 #######################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 Create a distance matrix from a numeric metadata column. The Euclidean
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 distance is computed between each pair of samples or features in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 column. Tip: the distance matrix produced by this method can be used as
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 input to the Mantel test available in `q2-diversity`.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 metadata : MetadataColumn[Numeric]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 Numeric metadata column to compute pairwise Euclidean distances from
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 distance_matrix : DistanceMatrix
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 </tool>