annotate qiime2/qiime_feature-table_rarefy.xml @ 4:71f124e02000 draft default tip

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