annotate qiime2/qiime_feature-table_rarefy.xml @ 9:f190567fe3f6 draft

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