comparison qiime2/qiime_sample-classifier_split-table.xml @ 14:a0a8d77a991c draft

Uploaded
author florianbegusch
date Thu, 03 Sep 2020 09:51:29 +0000
parents f190567fe3f6
children
comparison
equal deleted inserted replaced
13:887cd4ad8e16 14:a0a8d77a991c
1 <?xml version="1.0" ?> 1 <?xml version="1.0" ?>
2 <tool id="qiime_sample-classifier_split-table" name="qiime sample-classifier split-table" version="2019.7"> 2 <tool id="qiime_sample-classifier_split-table" name="qiime sample-classifier split-table"
3 <description> - Split a feature table into training and testing sets.</description> 3 version="2020.8">
4 <requirements> 4 <description>Split a feature table into training and testing sets.</description>
5 <requirement type="package" version="2019.7">qiime2</requirement> 5 <requirements>
6 </requirements> 6 <requirement type="package" version="2020.8">qiime2</requirement>
7 <command><![CDATA[ 7 </requirements>
8 <command><![CDATA[
8 qiime sample-classifier split-table 9 qiime sample-classifier split-table
9 10
10 --i-table=$itable 11 --i-table=$itable
11 --m-metadata-column="$mmetadatacolumn" 12 # if $input_files_mmetadatafile:
13 # def list_dict_to_string(list_dict):
14 # set $file_list = list_dict[0]['additional_input'].__getattr__('file_name')
15 # for d in list_dict[1:]:
16 # set $file_list = $file_list + ' --m-metadata-file=' + d['additional_input'].__getattr__('file_name')
17 # end for
18 # return $file_list
19 # end def
20 --m-metadata-file=$list_dict_to_string($input_files_mmetadatafile)
21 # end if
22
23 #if '__ob__' in str($mmetadatacolumn):
24 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__ob__', '[')
25 #set $mmetadatacolumn = $mmetadatacolumn_temp
26 #end if
27 #if '__cb__' in str($mmetadatacolumn):
28 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__cb__', ']')
29 #set $mmetadatacolumn = $mmetadatacolumn_temp
30 #end if
31 #if 'X' in str($mmetadatacolumn):
32 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('X', '\\')
33 #set $mmetadatacolumn = $mmetadatacolumn_temp
34 #end if
35 #if '__sq__' in str($mmetadatacolumn):
36 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__sq__', "'")
37 #set $mmetadatacolumn = $mmetadatacolumn_temp
38 #end if
39 #if '__db__' in str($mmetadatacolumn):
40 #set $mmetadatacolumn_temp = $mmetadatacolumn.replace('__db__', '"')
41 #set $mmetadatacolumn = $mmetadatacolumn_temp
42 #end if
43
44 --m-metadata-column=$mmetadatacolumn
12 45
13 46
14 47 --p-test-size=$ptestsize
15 #if $metadatafile:
16 --m-metadata-file=$metadatafile
17 #end if
18
19
20
21
22 #if str($ptestsize):
23 --p-test-size=$ptestsize
24 #end if
25 48
26 #if str($prandomstate): 49 #if str($prandomstate):
27 --p-random-state="$prandomstate" 50 --p-random-state=$prandomstate
28 #end if 51 #end if
29
30 #if $pnostratify: 52 #if $pnostratify:
31 --p-no-stratify 53 --p-no-stratify
32 #end if 54 #end if
33 55
34 #if str($pmissingsamples) != 'None': 56 #if str($pmissingsamples) != 'None':
35 --p-missing-samples=$pmissingsamples 57 --p-missing-samples=$pmissingsamples
36 #end if 58 #end if
37 59
38 --o-training-table=otrainingtable 60 --o-training-table=otrainingtable
61
39 --o-test-table=otesttable 62 --o-test-table=otesttable
63
64 #if str($examples) != 'None':
65 --examples=$examples
66 #end if
67
40 ; 68 ;
41 cp otrainingtable.qza $otrainingtable; 69 cp otesttable.qza $otesttable
42 cp otesttable.qza $otesttable;
43 ]]></command>
44 <inputs>
45 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] Feature table containing all features that should be used for target prediction. [required]" name="itable" optional="False" type="data"/>
46 <param label="--m-metadata-column: COLUMN MetadataColumn[Numeric | Categorical] Numeric metadata column to use as prediction target. [required]" name="mmetadatacolumn" optional="False" type="text"/>
47 <param label="--p-test-size: PROPORTION Range(0.0, 1.0, inclusive_start=False) Fraction of input samples to exclude from training set and use for classifier testing. [default: 0.2]" name="ptestsize" optional="True" type="float" value="0.2" min="0" max="1" exclusive_end="True"/>
48 <param label="--p-random-state: INTEGER Seed used by random number generator. [optional]" name="prandomstate" optional="True" type="integer"/>
49 <param label="--p-no-stratify: Evenly stratify training and test data among metadata categories. If True, all values in column must match at least two samples. [default: False]" name="pnostratify" selected="False" type="boolean"/>
50 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
51 <option selected="True" value="None">Selection is Optional</option>
52 <option value="error">error</option>
53 <option value="ignore">ignore</option>
54 </param>
55 70
56 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" /> 71 ]]></command>
72 <inputs>
73 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency¹ | RelativeFrequency² | PresenceAbsence³ | Balance⁴ | PercentileNormalized⁵ | Design⁶] Feature table containing all features that should be used for target prediction. [required]" name="itable" optional="False" type="data" />
74 <repeat name="input_files_mmetadatafile" optional="True" title="--m-metadata-file">
75 <param format="tabular,qza,no_unzip.zip" label="--m-metadata-file: METADATA" name="additional_input" optional="True" type="data" />
76 </repeat>
77 <param label="--m-metadata-column: COLUMN MetadataColumn[Numeric | Categorical] Numeric metadata column to use as prediction target. [required]" name="mmetadatacolumn" optional="False" type="text" />
78 <param exclude_min="True" label="--p-test-size: PROPORTION Range(0.0, 1.0, inclusive_start=False) Fraction of input samples to exclude from training set and use for classifier testing. [default: 0.2]" max="1.0" min="0.0" name="ptestsize" optional="True" type="float" value="0.2" />
79 <param label="--p-random-state: INTEGER Seed used by random number generator. [optional]" name="prandomstate" optional="False" type="text" />
80 <param label="--p-no-stratify: Do not evenly stratify training and test data among metadata categories. If True, all values in column must match at least two samples. [default: True]" name="pnostratify" selected="False" type="boolean" />
81 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
82 <option selected="True" value="None">Selection is Optional</option>
83 <option value="error">error</option>
84 <option value="ignore">ignore</option>
85 </param>
86 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
87
88 </inputs>
57 89
58 </inputs> 90 <outputs>
59 <outputs> 91 <data format="qza" label="${tool.name} on ${on_string}: trainingtable.qza" name="otrainingtable" />
60 <data format="qza" label="${tool.name} on ${on_string}: trainingtable.qza" name="otrainingtable"/> 92 <data format="qza" label="${tool.name} on ${on_string}: testtable.qza" name="otesttable" />
61 <data format="qza" label="${tool.name} on ${on_string}: testtable.qza" name="otesttable"/> 93
62 </outputs> 94 </outputs>
63 <help><![CDATA[ 95
96 <help><![CDATA[
64 Split a feature table into training and testing sets. 97 Split a feature table into training and testing sets.
65 ##################################################### 98 ###############################################################
66 99
67 Split a feature table into training and testing sets. By default stratifies 100 Split a feature table into training and testing sets. By default stratifies
68 training and test sets on a metadata column, such that values in that 101 training and test sets on a metadata column, such that values in that
69 column are evenly represented across training and test sets. 102 column are evenly represented across training and test sets.
70 103
71 Parameters 104 Parameters
72 ---------- 105 ----------
73 table : FeatureTable[Frequency] 106 table : FeatureTable[Frequency¹ | RelativeFrequency² | PresenceAbsence³ | Balance⁴ | PercentileNormalized⁵ | Design⁶]
74 Feature table containing all features that should be used for target 107 Feature table containing all features that should be used for target
75 prediction. 108 prediction.
76 metadata : MetadataColumn[Numeric | Categorical] 109 metadata : MetadataColumn[Numeric | Categorical]
77 Numeric metadata column to use as prediction target. 110 Numeric metadata column to use as prediction target.
78 test_size : Float % Range(0.0, 1.0, inclusive_start=False), optional 111 test_size : Float % Range(0.0, 1.0, inclusive_start=False), optional
89 metadata to be filtered, so that only samples found in both files are 122 metadata to be filtered, so that only samples found in both files are
90 retained. 123 retained.
91 124
92 Returns 125 Returns
93 ------- 126 -------
94 training_table : FeatureTable[Frequency] 127 training_table : FeatureTable[Frequency¹ | RelativeFrequency² | PresenceAbsence³ | Balance⁴ | PercentileNormalized⁵ | Design⁶]
95 Feature table containing training samples 128 Feature table containing training samples
96 test_table : FeatureTable[Frequency] 129 test_table : FeatureTable[Frequency¹ | RelativeFrequency² | PresenceAbsence³ | Balance⁴ | PercentileNormalized⁵ | Design⁶]
97 Feature table containing test samples 130 Feature table containing test samples
98 ]]></help> 131 ]]></help>
99 <macros> 132 <macros>
100 <import>qiime_citation.xml</import> 133 <import>qiime_citation.xml</import>
101 </macros> 134 </macros>
102 <expand macro="qiime_citation"/> 135 <expand macro="qiime_citation"/>
103 </tool> 136 </tool>