annotate qiime2/qiime_feature-table_rarefy.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_rarefy" name="qiime feature-table rarefy" version="2018.4">
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Rarefy 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 rarefy --i-table=$itable --p-sampling-depth="$psamplingdepth"
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-rarefied-table=orarefiedtable;
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
15
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
16 cp orarefiedtable.qza $orarefiedtable;
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 rarefied. [required]" name="itable" optional="False" type="data"/>
51b9b6b57732 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"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
22 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
23 </inputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
24 <outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
25 <data format="qza" label="${tool.name} on ${on_string}: rarefied-table.qza" name="orarefiedtable"/>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
26 </outputs>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
27 <help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
28 <![CDATA[
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
29 Rarefy table
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
30 -------------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
31
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
32 Subsample frequencies from all samples without replacement so that the sum
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
33 of frequencies in each sample is equal to sampling-depth.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
34
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
35 Parameters
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
36 ----------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
37 table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
38 The feature table to be rarefied.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
39 sampling_depth : Int % Range(1, None)
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
40 The total frequency that each sample should be rarefied to. Samples
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
41 where the sum of frequencies is less than the sampling depth will be
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
42 not be included in the resulting table.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
43
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
44 Returns
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
45 -------
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
46 rarefied_table : FeatureTable[Frequency]
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
47 The resulting rarefied feature table.
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
48 ]]>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
49 </help>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
50 <macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
51 <import>qiime_citation.xml</import>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
52 </macros>
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
53 <expand macro="qiime_citation" />
51b9b6b57732 Uploaded
florianbegusch
parents:
diff changeset
54 </tool>