[rkward-cvs] SF.net SVN: rkward: [1338] trunk/rkward/rkward/plugins/analysis

[tfry at users.sourceforge.net]

Revision: 1338
          http://svn.sourceforge.net/rkward/?rev=1338&view=rev
Author:   tfry
Date:     2007-02-05 13:10:14 -0800 (Mon, 05 Feb 2007)

Log Message:
-----------
add help page for correlation matrix

Modified Paths:
--------------
    trunk/rkward/rkward/plugins/analysis/corr_matrix.xml

Added Paths:
-----------
    trunk/rkward/rkward/plugins/analysis/corr_matrix.rkh

Added: trunk/rkward/rkward/plugins/analysis/corr_matrix.rkh
===================================================================
--- trunk/rkward/rkward/plugins/analysis/corr_matrix.rkh	                        (rev 0)
+++ trunk/rkward/rkward/plugins/analysis/corr_matrix.rkh	2007-02-05 21:10:14 UTC (rev 1338)
@@ -0,0 +1,25 @@
+<!DOCTYPE rkhelp>
+<document>
+	<summary>
+Calculate a correlation matrix given a number of numerical input vectors.
+	</summary>
+
+	<usage>
+Chose the vectors to calculate correlations for. A correlation is calculated for each pair of vectors. Optionally, (two-sided) p-values are calculated for each pair.
+	</usage>
+
+	<settings>
+		<caption id="tab_variables"/>
+		<setting id="x">Select the vectors to be correlated. The vectors need to be numeric, and of equal length.</setting>
+		<caption id="tab_options"/>
+		<setting id="do_p">If checked, an additional table with the (two-sided) significance values is calculated and printed.</setting>
+		<setting id="method">Method of correlation to be used</setting>
+		<setting id="use">In case of missing values, should be row be excluded from all calculation (i.e. even for those pairs of variables, where neither value is missing), or should they only be excluded for those pairs where it is actually missing?</setting>
+	</settings>
+	<related>
+		<ul>
+			<li><link href="rkward://rhelp/cor"/></li>
+			<li><link href="rkward://rhelp/cor.test"/></li>
+		</ul>
+	</related>
+</document>

Modified: trunk/rkward/rkward/plugins/analysis/corr_matrix.xml
===================================================================
--- trunk/rkward/rkward/plugins/analysis/corr_matrix.xml	2007-02-05 20:45:30 UTC (rev 1337)
+++ trunk/rkward/rkward/plugins/analysis/corr_matrix.xml	2007-02-05 21:10:14 UTC (rev 1338)
@@ -2,16 +2,17 @@
 
 <document>
 	<code file="corr_matrix.php"/>
+	<help file="corr_matrix.rkh"/>
 
 	<dialog label="Correlation matrix">
 		<tabbook>
-			<tab label="variables">
+			<tab id="tab_variables" label="Variables">
 				<row>
 					<varselector id="vars"/>
 					<varslot type="numeric" min_vars="2" multi="true" id="x" source="vars" required="true" label="variable(s):"/>
 				</row>
 			</tab>
-			<tab label="options">
+			<tab id="tab_options" label="Options">
 				<checkbox id="do_p" label="Calculate p values" checked="true"/>
 				<radio id="method" label="Method">
 					<option value="pearson" label="Pearson"/>


This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.