diff qiime2/qiime_sample-classifier_predict-regression.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
line wrap: on
line diff
--- /dev/null	Thu Jan 01 00:00:00 1970 +0000
+++ b/qiime2/qiime_sample-classifier_predict-regression.xml	Fri Sep 04 13:12:49 2020 +0000
@@ -0,0 +1,68 @@
+<?xml version="1.0" ?>
+<tool id="qiime_sample-classifier_predict-regression" name="qiime sample-classifier predict-regression"
+      version="2020.8">
+  <description>Use trained regressor to predict target values for new samples.</description>
+  <requirements>
+    <requirement type="package" version="2020.8">qiime2</requirement>
+  </requirements>
+  <command><![CDATA[
+qiime sample-classifier predict-regression
+
+--i-table=$itable
+
+--i-sample-estimator=$isampleestimator
+
+--p-n-jobs=$pnjobs
+
+--o-predictions=opredictions
+
+#if str($examples) != 'None':
+--examples=$examples
+#end if
+
+;
+cp opredictions.qza $opredictions
+
+  ]]></command>
+  <inputs>
+    <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" />
+    <param format="qza,no_unzip.zip" label="--i-sample-estimator: ARTIFACT SampleEstimator[Regressor] Sample regressor trained with fit_regressor. [required]" name="isampleestimator" optional="False" type="data" />
+    <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
+    
+  </inputs>
+
+  <outputs>
+    <data format="qza" label="${tool.name} on ${on_string}: predictions.qza" name="opredictions" />
+    
+  </outputs>
+
+  <help><![CDATA[
+Use trained regressor to predict target values for new samples.
+###############################################################
+
+Use trained estimator to predict target values for new samples. These will
+typically be unseen samples, e.g., test data (derived manually or from
+split_table) or samples with unknown values, but can theoretically be any
+samples present in a feature table that contain overlapping features with
+the feature table used to train the estimator.
+
+Parameters
+----------
+table : FeatureTable[Frequency]
+    Feature table containing all features that should be used for target
+    prediction.
+sample_estimator : SampleEstimator[Regressor]
+    Sample regressor trained with fit_regressor.
+n_jobs : Int, optional
+    Number of jobs to run in parallel.
+
+Returns
+-------
+predictions : SampleData[RegressorPredictions]
+    Predicted target values for each input sample.
+  ]]></help>
+  <macros>
+    <import>qiime_citation.xml</import>
+  </macros>
+  <expand macro="qiime_citation"/>
+</tool>
\ No newline at end of file