annotate linear_regression.xml @ 0:5cbb241afdc5 draft default tip

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