annotate qiime2/qiime_feature-table_rarefy.xml @ 15:276ec629f09a draft

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