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