annotate qiime2/qiime_feature-table_group.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-table_group" name="qiime feature-table group"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Group samples or features by a metadata column</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-table group
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --p-axis=$paxis
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14 # if $input_files_mmetadatafile:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 # def list_dict_to_string(list_dict):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 # for d in list_dict[1:]:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 # end for
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 # return $file_list
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 # end def
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 # end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 #if '__ob__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__ob__', '[')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 #if '__cb__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__cb__', ']')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 #if 'X' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('X', '\\')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 #if '__sq__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__sq__', "'")
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 #if '__db__' in str($mmetadatacolumn):
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__db__', '"')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 #set $mmetadatacolumn = $mmetadatacolumn_temp
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 --m-metadata-column=$mmetadatacolumn
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 --p-mode=$pmode
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 --o-grouped-table=ogroupedtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 cp ogroupedtable.qza $ogroupedtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The table to group samples or features on. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 <param label="--p-axis: " name="paxis" optional="False" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 <option value="sample">sample</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 <option value="feature">feature</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA" name="additional_input" optional="True" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 </repeat>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 <param label="--m-metadata-column: COLUMN MetadataColumn[Categorical] A column defining the groups. Each unique value will become a new ID for the table on the given `axis`. [required]" name="mmetadatacolumn" optional="False" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 <param label="--p-mode: " name="pmode" optional="False" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 <option value="sum">sum</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73 <option value="mean-ceiling">mean-ceiling</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 <option value="median-ceiling">median-ceiling</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 <data format="qza" label="${tool.name} on ${on_string}: groupedtable.qza" name="ogroupedtable" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
83 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
84
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
85 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
86 Group samples or features by a metadata column
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
87 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
88
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
89 Group samples or features in a feature table using metadata to define the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
90 mapping of IDs to a group.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
91
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
92 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
93 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
94 table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
95 The table to group samples or features on.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
96 axis : Str % Choices('sample', 'feature')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
97 Along which axis to group. Each ID in the given axis must exist in
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
98 `metadata`.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
99 metadata : MetadataColumn[Categorical]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
100 A column defining the groups. Each unique value will become a new ID
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
101 for the table on the given `axis`.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
102 mode : Str % Choices('sum', 'mean-ceiling', 'median-ceiling')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
103 How to combine samples or features within a group. `sum` will sum the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
104 frequencies across all samples or features within a group; `mean-
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
105 ceiling` will take the ceiling of the mean of these frequencies;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
106 `median-ceiling` will take the ceiling of the median of these
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
107 frequencies.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
108
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
109 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
110 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
111 grouped_table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
112 A table that has been grouped along the given `axis`. IDs on that axis
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
113 are replaced by values in the `metadata` column.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
114 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
115 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
116 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
117 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
118 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
119 </tool>