annotate qiime_feature-table_rarefy.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400 (2018-05-24)
parents 09b7bcb72fa7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-table_rarefy" name="qiime feature-table rarefy" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Rarefy table</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-table rarefy --i-table=$itable --p-sampling-depth="$psamplingdepth"
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14 --o-rarefied-table=orarefiedtable;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 cp orarefiedtable.qza $orarefiedtable;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18 </command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Frequency] The feature table to be rarefied. [required]" name="itable" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 <param label="--p-sampling-depth: The total frequency that each sample should be rarefied to. Samples where the sum of frequencies is less than the sampling depth will be not be included in the resulting table. [required]" name="psamplingdepth" optional="False" type="text"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 <data format="qza" label="${tool.name} on ${on_string}: rarefied-table.qza" name="orarefiedtable"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 <help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 Rarefy table
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 -------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 Subsample frequencies from all samples without replacement so that the sum
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33 of frequencies in each sample is equal to sampling-depth.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38 The feature table to be rarefied.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 sampling_depth : Int % Range(1, None)
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 The total frequency that each sample should be rarefied to. Samples
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 where the sum of frequencies is less than the sampling depth will be
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 not be included in the resulting table.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 rarefied_table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 The resulting rarefied feature table.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 </tool>