annotate qiime2/qiime_feature-table_group.xml @ 0:370e0b6e9826 draft

Uploaded
author florianbegusch
date Wed, 17 Jul 2019 03:05:17 -0400
parents
children 914fa4daf16a
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_feature-table_group" name="qiime feature-table group" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Group samples or features by a 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 feature-table group
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --p-axis=$paxis
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 --p-mode=$pmode
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 #if $input_files_mmetadatafile:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #def list_dict_to_string(list_dict):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 #set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 #for d in list_dict[1:]:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 #set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 #end for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 #return $file_list
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 #end def
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 --o-grouped-table=ogroupedtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 cp ogroupedtable.qza $ogroupedtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 <param label="--p-axis: " name="paxis" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 <option value="feature">feature</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 <option value="sample">sample</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 <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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 <param label="--p-mode: " name="pmode" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 <option value="median-ceiling">median-ceiling</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 <option value="mean-ceiling">mean-ceiling</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 <option value="sum">sum</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 <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
47 </repeat>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <data format="qza" label="${tool.name} on ${on_string}: groupedtable.qza" name="ogroupedtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 Group samples or features by a metadata column
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 ##############################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 Group samples or features in a feature table using metadata to define the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 mapping of IDs to a group.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 The table to group samples or features on.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 axis : Str % Choices('sample', 'feature')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 Along which axis to group. Each ID in the given axis must exist in
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66 `metadata`.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 metadata : MetadataColumn[Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 A column defining the groups. Each unique value will become a new ID
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 for the table on the given `axis`.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70 mode : Str % Choices('median-ceiling', 'mean-ceiling', 'sum')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 How to combine samples or features within a group. `sum` will sum the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 frequencies across all samples or features within a group; `mean-
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 ceiling` will take the ceiling of the mean of these frequencies;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 `median-ceiling` will take the ceiling of the median of these
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 frequencies.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 grouped_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 A table that has been grouped along the given `axis`. IDs on that axis
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 are replaced by values in the `metadata` column.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 </tool>