annotate qiime_feature-table_core-features.xml @ 1:f2028d8efed6 draft default tip

Add tool_data_table_conf.xml.sample
author florianbegusch
date Thu, 24 May 2018 03:40:50 -0400
parents 09b7bcb72fa7
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
1 <?xml version="1.0" ?>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
2 <tool id="qiime_feature-table_core-features" name="qiime feature-table core-features" version="2018.4">
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
3 <description> - Identify core features in table</description>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
4 <requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
5 <requirement type="package" version="2018.4">qiime2</requirement>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
6 </requirements>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
7 <command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
8 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
9 qiime feature-table core-features --i-table=$itable
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
10
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
11 #if str($cmdconfig) != 'None':
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
12 --cmd-config=$cmdconfig
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
13 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
14
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
15 #if $pminfraction:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
16 --p-min-fraction=$pminfraction
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
17 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
18
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
19 #if $pmaxfraction:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
20 --p-max-fraction=$pmaxfraction
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
21 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
22 --o-visualization=ovisualization
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
23 #if $psteps:
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
24 --p-steps=$psteps
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
25 #end if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
26 ;
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
27 qiime tools export ovisualization.qzv --output-dir out && mkdir -p '$ovisualization.files_path'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
28 && cp -r out/* '$ovisualization.files_path'
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
29 && mv '$ovisualization.files_path/index.html' '$ovisualization';
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
30 ]]></command>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
31 <inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
32 <param format="qza,no_unzip.zip" label="--i-table: FeatureTable[Frequency] The feature table to use in core features calculations. [required]" name="itable" optional="False" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
33
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
34 <param label="--p-min-fraction: The minimum fraction of samples that a feature must be observed in for that feature to be considered a core feature. [default: 0.5]" name="pminfraction" optional="True" type="float" value="0.5"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
35 <param label="--p-max-fraction: The maximum fraction of samples that a feature must be observed in for that feature to be considered a core feature. [default: 1.0]" name="pmaxfraction" optional="True" type="float" value="1.0"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
36
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
37 <param label="--p-steps: The number of steps to take between `min_fraction` and `max_fraction` for core features calculations. This parameter has no effect if `min_fraction` and `max_fraction` are the same value. [default: 11]" name="psteps" optional="True" type="integer" value="11"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
38
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
39 <param label="--cmd-config: Use config file for command options" name="cmdconfig" optional="True" type="data"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
40 </inputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
41 <outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
42 <data format="html" label="${tool.name} on ${on_string}: visualization.qzv" name="ovisualization"/>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
43 </outputs>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
44 <help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
45 <![CDATA[
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
46 Identify core features in table
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
47 --------------------------------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
48
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
49 Identify "core" features, which are features observed in a user-defined
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
50 fraction of the samples. Since the core features are a function of the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
51 fraction of samples that the feature must be observed in to be considered
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
52 core, this is computed over a range of fractions defined by the
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
53 `min_fraction`, `max_fraction`, and `steps` parameters.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
54
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
55 Parameters
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
56 ----------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
57 table : FeatureTable[Frequency]
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
58 The feature table to use in core features calculations.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
59 min_fraction : Float % Range(0.0, 1.0, inclusive_start=False), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
60 The minimum fraction of samples that a feature must be observed in for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
61 that feature to be considered a core feature.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
62 max_fraction : Float % Range(0.0, 1.0, inclusive_end=True), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
63 The maximum fraction of samples that a feature must be observed in for
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
64 that feature to be considered a core feature.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
65 steps : Int % Range(2, None), optional
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
66 The number of steps to take between `min_fraction` and `max_fraction`
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
67 for core features calculations. This parameter has no effect if
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
68 `min_fraction` and `max_fraction` are the same value.
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
69
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
70 Returns
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
71 -------
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
72 visualization : Visualization
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
73 \
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
74 ]]>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
75 </help>
09b7bcb72fa7 Uploaded
florianbegusch
parents:
diff changeset
76 </tool>