annotate qiime2-2020.8/qiime_feature-table_rarefy.xml @ 20:d93d8888f0b0 draft

Uploaded
author florianbegusch
date Fri, 04 Sep 2020 12:44:24 +0000
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-table_rarefy" name="qiime feature-table rarefy"
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Rarefy table</description>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
5 <requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
6 <requirement type="package" version="2020.8">qiime2</requirement>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
7 </requirements>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
8 <command><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-table rarefy
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
10
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
11 --i-table=$itable
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
12
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
13 --p-sampling-depth=$psamplingdepth
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
14
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
15 #if $pwithreplacement:
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
16 --p-with-replacement
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
18
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
19 --o-rarefied-table=orarefiedtable
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
20
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
21 #if str($examples) != 'None':
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
22 --examples=$examples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
23 #end if
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
24
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
25 ;
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
26 cp orarefiedtable.qza $orarefiedtable
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
27
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
28 ]]></command>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
29 <inputs>
d93d8888f0b0 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" />
d93d8888f0b0 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" />
d93d8888f0b0 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" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
33 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
34
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
35 </inputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
36
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
37 <outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
38 <data format="qza" label="${tool.name} on ${on_string}: rarefiedtable.qza" name="orarefiedtable" />
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
39
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
40 </outputs>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
41
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
42 <help><![CDATA[
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
43 Rarefy table
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
44 ###############################################################
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
45
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
46 Subsample frequencies from all samples so that the sum of frequencies in
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
47 each sample is equal to sampling-depth.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
48
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
49 Parameters
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
50 ----------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
51 table : FeatureTable[Frequency]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
52 The feature table to be rarefied.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
53 sampling_depth : Int % Range(1, None)
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
54 The total frequency that each sample should be rarefied to. Samples
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
55 where the sum of frequencies is less than the sampling depth will be
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
56 not be included in the resulting table unless subsampling is performed
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
57 with replacement.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
58 with_replacement : Bool, optional
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
59 Rarefy with replacement by sampling from the multinomial distribution
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
60 instead of rarefying without replacement.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
61
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
62 Returns
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
63 -------
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
64 rarefied_table : FeatureTable[Frequency]
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
65 The resulting rarefied feature table.
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
66 ]]></help>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
67 <macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
68 <import>qiime_citation.xml</import>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
69 </macros>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
70 <expand macro="qiime_citation"/>
d93d8888f0b0 Uploaded
florianbegusch
parents:
diff changeset
71 </tool>