annotate linear_regression.xml @ 83:4a25bb3a8c69 draft

Uploaded
author bernhardlutz
date Mon, 20 Jan 2014 16:19:34 -0500
parents c4a3a8999945
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
80
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
1 <tool id="LinearRegression1" name="Perform Linear Regression" version="1.1.0">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
2 <description> </description>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
3 <expand macro="requirements" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
4 <macros>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
5 <import>statistic_tools_macros.xml</import>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
6 </macros>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
7 <command interpreter="python">
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
8 linear_regression.py
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
9 $input1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
10 $response_col
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
11 $predictor_cols
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
12 $out_file1
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
13 $out_file2
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
14 1>/dev/null
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
15 </command>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
16 <inputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
17 <param format="tabular" name="input1" type="data" label="Select data" help="Dataset missing? See TIP below."/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
18 <param name="response_col" label="Response column (Y)" type="data_column" data_ref="input1" numerical="True"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
19 <param name="predictor_cols" label="Predictor columns (X)" type="data_column" data_ref="input1" numerical="True" multiple="true" >
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
20 <validator type="no_options" message="Please select at least one column."/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
21 </param>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
22 </inputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
23 <outputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
24 <data format="input" name="out_file1" metadata_source="input1" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
25 <data format="pdf" name="out_file2" />
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
26 </outputs>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
27 <tests>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
28 <test>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
29 <param name="input1" value="regr_inp.tabular"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
30 <param name="response_col" value="3"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
31 <param name="predictor_cols" value="1,2"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
32 <output name="out_file1" file="regr_out.tabular"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
33 <output name="out_file2" file="regr_out.pdf"/>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
34 </test>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
35 </tests>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
36 <help>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
37
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
38
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
39 .. class:: infomark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
40
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
41 **TIP:** If your data is not TAB delimited, use *Edit Datasets-&gt;Convert characters*
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
42
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
43 -----
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
44
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
45 .. class:: infomark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
46
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
47 **What it does**
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
48
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
49 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.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
50
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
51 *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.*
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
52
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
53 -----
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
54
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
55 .. class:: warningmark
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
56
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
57 **Note**
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
58
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
59 - This tool currently treats all predictor and response variables as continuous numeric variables. Running the tool on categorical variables might result in incorrect results.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
60
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
61 - Rows containing non-numeric (or missing) data in any of the chosen columns will be skipped from the analysis.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
62
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
63 - The summary statistics in the output are described below:
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
64
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
65 - sigma: the square root of the estimated variance of the random error (standard error of the residiuals)
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
66 - R-squared: the fraction of variance explained by the model
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
67 - Adjusted R-squared: the above R-squared statistic adjusted, penalizing for the number of the predictors (p)
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
68 - 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.
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
69
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
70
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
71 </help>
c4a3a8999945 Uploaded
bernhardlutz
parents:
diff changeset
72 </tool>