annotate qiime2/qiime_feature-table_subsample.xml @ 29:3ba9833030c1 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 13:12:49 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
29
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-table_subsample" name="qiime feature-table subsample"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Subsample table</description>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-table subsample
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
10
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
12
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
13 --p-subsampling-depth=$psubsamplingdepth
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-axis=$paxis
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --o-sampled-table=osampledtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24 cp osampledtable.qza $osampledtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 <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" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 <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" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 <param label="--p-axis: " name="paxis" optional="False" type="select">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 <option value="sample">sample</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 <option value="feature">feature</option>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 </param>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 <data format="qza" label="${tool.name} on ${on_string}: sampledtable.qza" name="osampledtable" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 Subsample table
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 Randomly pick samples or features, without replacement, from the table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52 The feature table to be sampled.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 subsampling_depth : Int % Range(1, None)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 The total number of samples or features to be randomly sampled. Samples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 or features that are reduced to a zero sum will not be included in the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 resulting table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 axis : Str % Choices('sample', 'feature')
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 The axis to sample over. If "sample" then samples will be randomly
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 selected to be retained. If "feature" then a random set of features
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 will be selected to be retained.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 sampled_table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 The resulting subsampled feature table.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 </tool>