annotate community.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="community" name="Community" version="0.0.16">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
2 <description>'Community' Data Input</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">community.R
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
8 #if str($CountsFile).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
9 --CountsFile="$CountsFile"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
10 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
11 #if str($SamplesFile).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
12 --SamplesFile="$SamplesFile"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
13 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
14 #if str($K).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
15 --K="$K"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
16 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
17 #if str($A).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
18 --A="$A"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
19 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
20 #if str($Transform).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
21 --Transform="$Transform"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
22 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
23 #if str($SampleName).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
24 --SampleName="$SampleName"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
25 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
26 #if str($ColumnClasses).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
27 --ColumnClasses="$ColumnClasses"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
28 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
29 #if str($OutputFile).strip() != "":
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
30 --OutputFile="$OutputFile"
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
31 #end if
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
32
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
33 2&gt;&amp;1</command>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
34 <inputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
35 <param optional="false" name="CountsFile" type="data" help="Name of a CSV file containing OTU samples." label="[required] Counts File">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
36 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
37 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
38 <param optional="false" name="SamplesFile" type="data" help="Name of a CSV file containing sample data." label="[required] Samples File">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
39 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
40 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
41 <param optional="true" name="K" type="float" value="0" help="The parameters 'K' and 'A' together define a 'K over A'&#10;filter. The filter can be used to include only some taxa. The&#10;idea is that a taxonomic entity is only included if at least&#10;'A' reads are present in at least 'K' samples. The default is&#10;A = K = 0, i.e., include all taxa. Specify 'K' in the box&#10;above." label="K">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
42 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
43 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
44 <param optional="true" name="A" type="float" value="0" help="Include only taxa with at least K samples greater than A, as&#10;described for the parameter K." label="A">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
45 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
46 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
47 <param optional="true" name="Transform" type="select" help="(Optional) A transformation applied to all count data, after&#10;the 'K Over A' filter has been run. Possible values include&#10;&quot;log&quot; (actually, log(x + .5) to avoid logarithms of zero&#10;counts) and &quot;asinh&quot; (inverse hyperboloic sine, a log-like&#10;transformation with better behavior near zero)." label="Transform" force_select="FALSE">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
48 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
49 <option value="none">none</option>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
50 <option value="log">log</option>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
51 <option value="asinh">asinh</option>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
52 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
53 <param optional="true" name="SampleName" type="text" help="(Optional) Samples File column name containing names by&#10;which samples are identified in all subsequent calculations.&#10;If two rows have the same Sample Name, then corresponding&#10;counts in the Counts File are added together." size="60" label="Sample Name">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
54 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
55 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
56 <param optional="true" name="ColumnClasses" type="text" help="(Optional) Comma-separated names specifying how each&#10;column is to be represented. There must be as many names, and&#10;in the same order, as there are columns in the file. Typical&#10;values include: logical, integer, numeric, character, factor,&#10;Date. Use 'factor' to indicate a variable with discrete&#10;levels, e.g., sex (with levels Male, Female) tissue type&#10;(with levels Tumor, Normal), etc. When 'Date' is used, dates&#10;should be formatted consistently as year-month-day or&#10;year/month/day, e.g., 2014-03-26; poorly formed dates will be&#10;converted to 'NA' values." size="60" label="Column Classes">
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
57 <validator type="empty_field" message="This field is required."/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
58 </param>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
59 </inputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
60 <outputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
61 <data format="rda" name="OutputFile" label="community.rda"/>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
62 </outputs>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
63 <help>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
64 **Description**
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
65
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
66 Input a CSV file of integer-valued counts of each taxon (row) in
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
67 each sample (column), and a CSV file of annotations on each
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
68 sample. The result is used in down-stream analysis.
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
69 </help>
12b4f093e6c4 planemo upload commit 2774930eebe258ecd56c8f1c5ddabf5092282ab9
bcclaywell
parents:
diff changeset
70 </tool>