annotate ribbonPlot.xml @ 0:12b4f093e6c4 draft default tip

planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
author bcclaywell
date Mon, 12 Oct 2015 16:46:15 -0400
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
1 <tool id="ribbonPlot" name="Ribbon Plot" version="0.0.16">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
2 <description>Attribute Ribbon Plot of Clustered Samples</description>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
3 <requirements>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
4 <requirement type="package" version="3.1.2">R</requirement>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
5 <requirement type="package" version="2014-05-02">microbiome_community</requirement>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
6 </requirements>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
7 <command interpreter="Rscript --vanilla">ribbonPlot.R
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
8 #if str($CommunityFile).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
9 --CommunityFile="$CommunityFile"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
10 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
11 #if str($Attributes).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
12 --Attributes="$Attributes"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
13 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
14 #if str($ClusteringAlgorithm).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
15 --ClusteringAlgorithm="$ClusteringAlgorithm"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
16 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
17 #if str($OutputFile).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
18 --OutputFile="$OutputFile"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
19 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
20
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
21 2&gt;&amp;1</command>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
22 <inputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
23 <param optional="false" name="CommunityFile" format="rda" type="data" help="File created by the 'community' function." label="[required] Community File">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
24 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
25 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
26 <param optional="true" name="Attributes" type="text" help="Comma-separated names of SamplesFile columns on which&#10;ribbons are to be plotted. Samples are ordered by the first&#10;element of Attributes; Attributes must identify more than 1&#10;SampleFile column. Example: Nugent_3_group, Amsel,&#10;Nugent_Lactobacillus, pH, Clue" size="60" label="Attributes">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
27 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
28 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
29 <param optional="true" name="ClusteringAlgorithm" type="select" help="Algorithm to use for clustering samples, one of&#10;&quot;hclust&quot; or 'DirichletMultinomial&quot; (from the&#10;DirichletMultinomial package)." label="Clustering Algorithm" force_select="FALSE">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
30 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
31 <option value="hclust">hclust</option>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
32 <option value="DirichletMultinomial">DirichletMultinomial</option>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
33 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
34 </inputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
35 <outputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
36 <data format="svg" name="OutputFile" label="ribbonPlot.svg"/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
37 </outputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
38 <help>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
39 **Description**
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
40
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
41 Attributes of samples as heat maps, with samples clustered by one
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
42 of several algorithms
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
43 </help>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
44 </tool>