annotate tools/regVariation/linear_regression.xml @ 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="LinearRegression1" name="Perform Linear Regression" version="1.0.1">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
2 <description> </description>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
3 <command interpreter="python">
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
4 linear_regression.py
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
5 $input1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
6 $response_col
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
7 $predictor_cols
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
8 $out_file1
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
9 $out_file2
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
10 1>/dev/null
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
11 </command>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
12 <inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
13 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
14 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" numerical="True"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
15 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" numerical="True" multiple="true" >
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
16 <validator type="no_options" message="Please select at least one column."/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
17 </param>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
18 </inputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
19 <outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
20 <data format="input" name="out_file1" metadata_source="input1" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
21 <data format="pdf" name="out_file2" />
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
22 </outputs>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
23 <requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
24 <requirement type="python-module">rpy</requirement>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
25 </requirements>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
26 <tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
27 <test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
28 <param name="input1" value="regr_inp.tabular"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
29 <param name="response_col" value="3"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
30 <param name="predictor_cols" value="1,2"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
31 <output name="out_file1" file="regr_out.tabular"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
32 <output name="out_file2" file="regr_out.pdf"/>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
33 </test>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
34 </tests>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
35 <help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
36
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
37
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
38 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
39
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
40 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
41
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
42 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
43
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
44 .. class:: infomark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
45
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
46 **What it does**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
47
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
48 This tool uses the 'lm' function from R statistical package to perform linear regression on the input data. It outputs two files, one containing the summary statistics of the performed regression, and the other containing diagnostic plots to check whether model assumptions are satisfied.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
49
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
50 *R Development Core Team (2009). R: A language and environment for statistical computing. R Foundation for Statistical Computing, Vienna, Austria. ISBN 3-900051-07-0, URL http://www.R-project.org.*
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
51
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
52 -----
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
53
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
54 .. class:: warningmark
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
55
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
56 **Note**
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
57
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
58 - This tool currently treats all predictor and response variables as continuous numeric variables. Running the tool on categorical variables might result in incorrect results.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
59
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
60 - Rows containing non-numeric (or missing) data in any of the chosen columns will be skipped from the analysis.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
61
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
62 - The summary statistics in the output are described below:
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
63
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
64 - sigma: the square root of the estimated variance of the random error (standard error of the residiuals)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
65 - R-squared: the fraction of variance explained by the model
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
66 - Adjusted R-squared: the above R-squared statistic adjusted, penalizing for the number of the predictors (p)
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
67 - p-value: p-value for the t-test of the null hypothesis that the corresponding slope is equal to zero against the two-sided alternative.
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
68
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
69
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
70 </help>
9071e359b9a3 Uploaded
xuebing
parents:
diff changeset
71 </tool>