annotate qiime2/qiime_feature-table_core-features.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_core-features" name="qiime feature-table core-features"
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
3 version="2020.8">
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
4 <description>Identify core features in 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 core-features
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-min-fraction=$pminfraction
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
14
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
15 --p-max-fraction=$pmaxfraction
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
16
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
17 --p-steps=$psteps
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
18
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
19 --o-visualization=ovisualization
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 oclassifier.qza $oclassifier
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
27
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
28 ;
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
29 qiime tools export ovisualization.qzv --output-path out
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
30 && mkdir -p '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
31 && cp -r out/* '$ovisualization.files_path'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
32 && mv '$ovisualization.files_path/index.html' '$ovisualization'
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
33
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
34 ]]></command>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
35 <inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
36 <param format="qza,no_unzip.zip" label="--i-table: ARTIFACT FeatureTable[Frequency] The feature table to use in core features calculations. [required]" name="itable" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
37 <param exclude_min="True" label="--p-min-fraction: PROPORTION Range(0.0, 1.0, inclusive_start=False) The minimum fraction of samples that a feature must be observed in for that feature to be considered a core feature. [default: 0.5]" max="1.0" min="0.0" name="pminfraction" optional="True" type="float" value="0.5" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
38 <param exclude_max="False" label="--p-max-fraction: PROPORTION Range(0.0, 1.0, inclusive_end=True) The maximum fraction of samples that a feature must be observed in for that feature to be considered a core feature. [default: 1.0]" max="1.0" min="0.0" name="pmaxfraction" optional="True" type="float" value="1.0" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
39 <param label="--p-steps: INTEGER The number of steps to take between `min-fraction` and Range(2, None) `max-fraction` for core features calculations. This parameter has no effect if `min-fraction` and `max-fraction` are the same value. [default: 11]" min="2" name="psteps" optional="True" type="integer" value="11" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
40 <param label="--examples: Show usage examples and exit." name="examples" optional="False" type="data" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
41
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
42 </inputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
43
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
44 <outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
45 <data format="html" label="${tool.name} on ${on_string}: visualization.html" name="ovisualization" />
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
46
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
47 </outputs>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
48
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
49 <help><![CDATA[
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
50 Identify core features in table
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
51 ###############################################################
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
52
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
53 Identify "core" features, which are features observed in a user-defined
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
54 fraction of the samples. Since the core features are a function of the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
55 fraction of samples that the feature must be observed in to be considered
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
56 core, this is computed over a range of fractions defined by the
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
57 `min_fraction`, `max_fraction`, and `steps` parameters.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
58
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
59 Parameters
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
60 ----------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
61 table : FeatureTable[Frequency]
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
62 The feature table to use in core features calculations.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
63 min_fraction : Float % Range(0.0, 1.0, inclusive_start=False), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
64 The minimum fraction of samples that a feature must be observed in for
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
65 that feature to be considered a core feature.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
66 max_fraction : Float % Range(0.0, 1.0, inclusive_end=True), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
67 The maximum fraction of samples that a feature must be observed in for
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
68 that feature to be considered a core feature.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
69 steps : Int % Range(2, None), optional
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
70 The number of steps to take between `min_fraction` and `max_fraction`
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
71 for core features calculations. This parameter has no effect if
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
72 `min_fraction` and `max_fraction` are the same value.
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
73
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
74 Returns
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
75 -------
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
76 visualization : Visualization
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
77 ]]></help>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
78 <macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
79 <import>qiime_citation.xml</import>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
80 </macros>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
81 <expand macro="qiime_citation"/>
3ba9833030c1 Uploaded
florianbegusch
parents:
diff changeset
82 </tool>