annotate qiime2/qiime_feature-table_subsample.xml @ 0:51b9b6b57732 draft

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