annotate qiime2/qiime_feature-table_rarefy.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_rarefy" name="qiime feature-table rarefy"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Rarefy 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 rarefy
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-sampling-depth=$psamplingdepth
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 #if $pwithreplacement:
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16 --p-with-replacement
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 --o-rarefied-table=orarefiedtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
20
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($examples) != 'None':
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
22 --examples=$examples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
24
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
25 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
26 cp orarefiedtable.qza $orarefiedtable
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table to be rarefied. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 <param label="--p-sampling-depth: INTEGER Range(1, None) 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 unless subsampling is performed with replacement. [required]" name="psamplingdepth" optional="False" type="text" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 <param label="--p-with-replacement: --p-with-replacement: / --p-no-with-replacement Rarefy with replacement by sampling from the multinomial distribution instead of rarefying without replacement. [default: False]" name="pwithreplacement" selected="False" type="boolean" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <data format="qza" label="${tool.name} on ${on_string}: rarefiedtable.qza" name="orarefiedtable" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43 Rarefy table
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46 Subsample frequencies from all samples so that the sum of frequencies in
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 each sample is equal to sampling-depth.
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 rarefied.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 sampling_depth : Int % Range(1, None)
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 The total frequency that each sample should be rarefied to. Samples
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 where the sum of frequencies is less than the sampling depth will be
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 not be included in the resulting table unless subsampling is performed
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 with replacement.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58 with_replacement : Bool, optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 Rarefy with replacement by sampling from the multinomial distribution
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 instead of rarefying without replacement.
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 rarefied_table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 The resulting rarefied 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>