annotate qiime2-2020.8/qiime_sample-classifier_metatable.xml @ 0:5c352d975ef7 draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:33:04 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_sample-classifier_metatable" name="qiime sample-classifier metatable"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Convert (and merge) positive numeric metadata (in)to feature table.</description>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime sample-classifier metatable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
10
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
11 #if str($itable) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
12 --i-table=$itable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
14 # if $input_files_mmetadatafile:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
15 # def list_dict_to_string(list_dict):
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
16 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
17 # for d in list_dict[1:]:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
18 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
19 # end for
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
20 # return $file_list
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
21 # end def
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
22 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
23 # end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
24
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
25 #if str($pmissingsamples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
26 --p-missing-samples=$pmissingsamples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
27 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
28
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
29 #if str($pmissingvalues) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
30 --p-missing-values=$pmissingvalues
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
31 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
32
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
33 #if $pdropallunique:
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
34 --p-drop-all-unique
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
35 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
36
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
37 --o-converted-table=oconvertedtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
38
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
39 #if str($examples) != 'None':
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
40 --examples=$examples
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
41 #end if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
42
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
43 ;
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
44 cp oconvertedtable.qza $oconvertedtable
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
45
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
46 ]]></command>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
47 <inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
48 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] Feature table containing all features that should be used for target prediction. [optional]" name="itable" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
49 <repeat name="input_files_mmetadatafile" optional="False" title="--m-metadata-file">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
50 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA... (multiple Metadata file to convert to feature table. arguments will be merged) [required]" name="additional_input" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
51 </repeat>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
52 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
53 <option selected="True" value="None">Selection is Optional</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
54 <option value="error">error</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
55 <option value="ignore">ignore</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
56 </param>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
57 <param label="--p-missing-values: " name="pmissingvalues" optional="True" type="select">
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
58 <option selected="True" value="None">Selection is Optional</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
59 <option value="drop_samples">drop_samples</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
60 <option value="drop_features">drop_features</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
61 <option value="error">error</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
62 <option value="fill">fill</option>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
63 </param>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
64 <param label="--p-drop-all-unique: --p-drop-all-unique: / --p-no-drop-all-unique If True, columns that contain a unique value for every ID will be dropped. [default: False]" name="pdropallunique" selected="False" type="boolean" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
65 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
66
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
67 </inputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
68
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
69 <outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
70 <data format="qza" label="${tool.name} on ${on_string}: convertedtable.qza" name="oconvertedtable" />
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
71
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
72 </outputs>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
73
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
74 <help><![CDATA[
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
75 Convert (and merge) positive numeric metadata (in)to feature table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
76 ###############################################################
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
77
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
78 Convert numeric sample metadata from TSV file into a feature table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
79 Optionally merge with an existing feature table. Only numeric metadata will
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
80 be converted; categorical columns will be silently dropped. By default, if
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
81 a table is used as input only samples found in both the table and metadata
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
82 (intersection) are merged, and others are silently dropped. Set
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
83 missing_samples="error" to raise an error if samples found in the table are
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
84 missing from the metadata file. The metadata file can always contain a
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
85 superset of samples. Note that columns will be dropped if they are non-
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
86 numeric, contain no unique values (zero variance), contain only empty
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
87 cells, or contain negative values. This method currently only converts
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
88 postive numeric metadata into feature data. Tip: convert categorical
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
89 columns to dummy variables to include them in the output feature table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
90
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
91 Parameters
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
92 ----------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
93 metadata : Metadata
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
94 Metadata file to convert to feature table.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
95 table : FeatureTable[Frequency], optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
96 Feature table containing all features that should be used for target
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
97 prediction.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
98 missing_samples : Str % Choices('error', 'ignore'), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
99 How to handle missing samples in metadata. "error" will fail if missing
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
100 samples are detected. "ignore" will cause the feature table and
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
101 metadata to be filtered, so that only samples found in both files are
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
102 retained.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
103 missing_values : Str % Choices('drop_samples', 'drop_features', 'error', 'fill'), optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
104 How to handle missing values (nans) in metadata. Either "drop_samples"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
105 with missing values, "drop_features" with missing values, "fill"
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
106 missing values with zeros, or "error" if any missing values are found.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
107 drop_all_unique : Bool, optional
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
108 If True, columns that contain a unique value for every ID will be
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
109 dropped.
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
110
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
111 Returns
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
112 -------
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
113 converted_table : FeatureTable[Frequency]
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
114 Converted feature table
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
115 ]]></help>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
116 <macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
117 <import>qiime_citation.xml</import>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
118 </macros>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
119 <expand macro="qiime_citation"/>
5c352d975ef7 Uploaded
florianbegusch
parents:
diff changeset
120 </tool>