annotate qiime2/qiime_sample-classifier_predict-classification.xml @ 4:914fa4daf16a draft

Fixes
author florianbegusch
date Wed, 31 Jul 2019 03:06:00 -0400
parents 370e0b6e9826
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_predict-classification" name="qiime sample-classifier predict-classification" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Use trained classifier to predict target values for new samples.</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 predict-classification
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
11 --i-sample-estimator=$isampleestimator
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
12
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
13 #set $pnjobs = '${GALAXY_SLOTS:-4}'
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
14
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
15 #if str($pnjobs):
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 --p-n-jobs="$pnjobs"
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 --o-predictions=opredictions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 cp opredictions.qza $opredictions
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 <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
25 <param format="qza,no_unzip.zip" label="--i-sample-estimator: ARTIFACT SampleEstimator[Classifier] Sample classifier trained with fit_classifier. [required]" name="isampleestimator" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 <data format="qza" label="${tool.name} on ${on_string}: predictions.qza" name="opredictions"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 Use trained classifier to predict target values for new samples.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 ################################################################
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 Use trained estimator to predict target values for new samples. These will
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 typically be unseen samples, e.g., test data (derived manually or from
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36 split_table) or samples with unknown values, but can theoretically be any
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 samples present in a feature table that contain overlapping features with
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38 the feature table used to train the estimator.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 Feature table containing all features that should be used for target
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 prediction.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 sample_estimator : SampleEstimator[Classifier]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 Sample classifier trained with fit_classifier.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 predictions : SampleData[ClassifierPredictions]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51 Predicted target values for each input sample.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 </tool>