annotate qiime2/qiime_sample-classifier_split-table.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents a025a4a89e07
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_sample-classifier_split-table" name="qiime sample-classifier split-table" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Split a feature table into training and testing sets.</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 sample-classifier split-table
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --m-metadata-column="$mmetadatacolumn"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
5
a025a4a89e07 Uploaded
florianbegusch
parents: 4
diff changeset
15 #if $metadatafile:
a025a4a89e07 Uploaded
florianbegusch
parents: 4
diff changeset
16 --m-metadata-file=$metadatafile
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20
5
a025a4a89e07 Uploaded
florianbegusch
parents: 4
diff changeset
21
a025a4a89e07 Uploaded
florianbegusch
parents: 4
diff changeset
22 #if str($ptestsize):
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 --p-test-size=$ptestsize
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 #if str($prandomstate):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 --p-random-state="$prandomstate"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 #if $pnostratify:
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 --p-no-stratify
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 #if str($pmissingsamples) != 'None':
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 --p-missing-samples=$pmissingsamples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 --o-training-table=otrainingtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 --o-test-table=otesttable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 cp otrainingtable.qza $otrainingtable;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 cp otesttable.qza $otesttable;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 <param label="--p-random-state: INTEGER Seed used by random number generator. [optional]" name="prandomstate" optional="True" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
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"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 <param label="--p-missing-samples: " name="pmissingsamples" optional="True" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 <option selected="True" value="None">Selection is Optional</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 <option value="error">error</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <option value="ignore">ignore</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55
5
a025a4a89e07 Uploaded
florianbegusch
parents: 4
diff changeset
56 <param label="--m-metadata-file METADATA" name="metadatafile" type="data" format="tabular,qza,no_unzip.zip" />
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <data format="qza" label="${tool.name} on ${on_string}: trainingtable.qza" name="otrainingtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 <data format="qza" label="${tool.name} on ${on_string}: testtable.qza" name="otesttable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
62 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
63 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
64 Split a feature table into training and testing sets.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
65 #####################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
66
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
67 Split a feature table into training and testing sets. By default stratifies
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
68 training and test sets on a metadata column, such that values in that
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
69 column are evenly represented across training and test sets.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
70
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
71 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
72 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
73 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
74 Feature table containing all features that should be used for target
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
75 prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
76 metadata : MetadataColumn[Numeric | Categorical]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
77 Numeric metadata column to use as prediction target.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
78 test_size : Float % Range(0.0, 1.0, inclusive_start=False), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
79 Fraction of input samples to exclude from training set and use for
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
80 classifier testing.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
81 random_state : Int, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
82 Seed used by random number generator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
83 stratify : Bool, optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
84 Evenly stratify training and test data among metadata categories. If
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
85 True, all values in column must match at least two samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
86 missing_samples : Str % Choices('error', 'ignore'), optional
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
87 How to handle missing samples in metadata. "error" will fail if missing
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
88 samples are detected. "ignore" will cause the feature table and
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
89 metadata to be filtered, so that only samples found in both files are
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
90 retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
91
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
92 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
93 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
94 training_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
95 Feature table containing training samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
96 test_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
97 Feature table containing test samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
98 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
99 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
100 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
101 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
102 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
103 </tool>