annotate qiime2/qiime_feature-table_subsample.xml @ 7:85b520815e85 draft

Uploaded
author florianbegusch
date Tue, 13 Aug 2019 07:53:59 -0400
parents de4c22a52df4
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_feature-table_subsample" name="qiime feature-table subsample" version="2019.4">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Subsample table</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 feature-table subsample
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
9
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
10 --i-table=$itable
6
florianbegusch
parents: 0
diff changeset
11
florianbegusch
parents: 0
diff changeset
12 #if str($psubsamplingdepth):
florianbegusch
parents: 0
diff changeset
13 --p-subsampling-depth="$psubsamplingdepth"
florianbegusch
parents: 0
diff changeset
14 #end if
florianbegusch
parents: 0
diff changeset
15
0
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
16 --p-axis=$paxis
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
17
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
18 --o-sampled-table=osampledtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
19 ;
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
20 cp osampledtable.qza $osampledtable
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
21 ]]></command>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
22 <inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
23 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table to be sampled. [required]" name="itable" optional="False" type="data"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
24 <param label="--p-subsampling-depth: INTEGER Range(1, None) The total number of samples or features to be randomly sampled. Samples or features that are reduced to a zero sum will not be included in the resulting table. [required]" name="psubsamplingdepth" optional="False" min="1" value="" type="integer"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
25 <param label="--p-axis: " name="paxis" optional="False" type="select">
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
26 <option value="sample">sample</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
27 <option value="feature">feature</option>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
28 </param>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
29 </inputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
30 <outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
31 <data format="qza" label="${tool.name} on ${on_string}: sampledtable.qza" name="osampledtable"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
32 </outputs>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
33 <help><![CDATA[
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
34 Subsample table
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
35 ###############
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
36
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
37 Randomly pick samples or features, without replacement, from the table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
38
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
39 Parameters
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
40 ----------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
41 table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
42 The feature table to be sampled.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
43 subsampling_depth : Int % Range(1, None)
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
44 The total number of samples or features to be randomly sampled. Samples
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
45 or features that are reduced to a zero sum will not be included in the
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
46 resulting table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
47 axis : Str % Choices('sample', 'feature')
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
48 The axis to sample over. If "sample" then samples will be randomly
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
49 selected to be retained. If "feature" then a random set of features
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
50 will be selected to be retained.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
51
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
52 Returns
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
53 -------
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
54 sampled_table : FeatureTable[Frequency]
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
55 The resulting subsampled feature table.
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
56 ]]></help>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
57 <macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
58 <import>qiime_citation.xml</import>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
59 </macros>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
60 <expand macro="qiime_citation"/>
370e0b6e9826 Uploaded
florianbegusch
parents:
diff changeset
61 </tool>