annotate tools/stats/gsummary.xml.groups @ 0:9071e359b9a3

Uploaded
author xuebing
date Fri, 09 Mar 2012 19:37:19 -0500
parents
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
0
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
1 <tool id="Summary Statistics1" name="Summary Statistics">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description>of a column in a tab delimited file according to an expression</description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">gsummary.py $input $out_file1 "$cond" "$groups"</command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 <param name="cond" size="40" type="text" value="c5" label="expression"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 <param name="groups" size="40" type="text" value="none" label="group terms (c1,c4,etc.)"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 <param format="txt" name="input" type="data" label="summary statistics on"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 <data format="txt" name="out_file1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 This tool expects input datasets to consist of tab-delimited columns (blank or comment lines beginning with a # character are automatically skipped).
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 **TIP:** If your data is not TAB delimited, use *Text Manipulation-&gt;Convert*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 **TIP:** Computing summary statistics may throw exceptions if the data value in every line of the columns being summarized is not numerical. If a line is missing a value or contains a non-numerical value in the column being summarized, that line is skipped and the value is not included in the statistical computation. The number of invalid skipped lines is documented in the resulting history item.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 **Syntax**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 This tool computes basic summary statistics on a given column, or on an expression containing those columns
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 - Columns are referenced with **c** and a **number**. For example, **c1** refers to the first column of a tab-delimited file
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 - To group the summary by the values in a column or columns, specify in the **group terms** box...
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 + **c1** *group by the values in column 1*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 + **c1,c4** *group by the values in column 1, then by the values in column 4*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39 **Expression examples**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41 - **log(c5)** calculates the summary statistics for the natural log of column 5
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 - **(c5 + c6 + c7) / 3** calculates the summary statistics on the average of columns 5-7
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43 - **log(c5,10)** summary statistics of the base 10 log of column 5
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 - **sqrt(c5+c9)** summary statistics of the square root of column 5 + column 9
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 **Group examples**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 - **c1** group by the values in column 1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49 - **c1,c4** group by the values in column 1, then by the values in column 4
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55 **TIP:** Most functions (like *abs*) take only a single expression. *log* can take one or two parameters, like *log(expression,base)*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57 Currently, these R functions are supported: *abs, sign, sqrt, floor, ceiling, trunc, round, signif, exp, log, cos, sin, tan, acos, asin, atan, cosh, sinh, tanh, acosh, asinh, atanh, lgamma, gamma, gammaCody, digamma, trigamma, cumsum, cumprod, cummax, cummin*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59 .. |INFO| image:: ./static/images/icon_info_sml.gif
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 </tool>