[rkward-cvs] SF.net SVN: rkward: [1099] trunk/rkward/rkward/plugins/descriptive

[tfry at users.sourceforge.net]

Revision: 1099
          http://svn.sourceforge.net/rkward/?rev=1099&view=rev
Author:   tfry
Date:     2007-01-08 08:41:50 -0800 (Mon, 08 Jan 2007)

Log Message:
-----------
Properly document descriptive statistics plugin

Modified Paths:
--------------
    trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.rkh
    trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.xml

Modified: trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.rkh
===================================================================
--- trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.rkh	2007-01-08 16:23:28 UTC (rev 1098)
+++ trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.rkh	2007-01-08 16:41:50 UTC (rev 1099)
@@ -7,10 +7,9 @@
 		Compute the most common descriptive statistics for one or more numeric vectors
 	</summary>
 	<usage>
-		If there are general usage instruction, not tied to an option, specify them here (see <link href="rkward://component/basic_statistics">testtitle</link>, and <link href="rkward://component/basic_statistics"/>, and <link href="rkward://rhelp/print"/>, and <link href="rkward://page/basic_functions"/>)
+		Select one or more objects to analyse. For most types of analysis, the objects need to be numeric vectors. On the subsequent tabs/pages specify, which statistics you want computed (see below for details).
 
-		Next paragraph
-		Same paragraph
+		Each selected variable will be analysed independently of the others. NA values are excluded from the calculations.
 	</usage>
 	<settings>
 		<caption id="tab_variables"/>
@@ -18,14 +17,31 @@
 		<caption id="tab_mean_sd"/>
 		<setting id="mean">Should the mean value be computed?</setting>
 		<setting id="trim">Trim of the mean. See <link href="rkward://rhelp/mean"/></setting>
+		<setting id="sd">Compute the standard deviation?</setting>
 		<caption id="tab_median_mad"/>
+		<setting id="median">Should the median value be computed?</setting>
+		<setting id="mad">Compute the median absolute deviation, i.e., the (lo-/hi-) median of the absolute deviations from the median, and (by default) adjust by a factor for asymptotically normal consistency (see <link href="rhelp://mad"/>).</setting>
+		<setting id="constant">Scale factor to use when computing the median absolute deviation</setting>
+		<setting id="mad_type">How to treat even size samples: Average the two middle values, take the lower, or take the higher</setting>
 		<caption id="tab_range_etc"/>
+		<setting id="range">Compute the range, i.e. lowest and highest value</setting>
+		<setting id="sum">Compute the sum of all values</setting>
+		<setting id="prod">Compute the product of all values</setting>
+		<setting id="length">Count the number of total values (including NAs)</setting>
+		<setting id="nacount">Count the number of NA values</setting>
 	</settings>
 	<related>
 		<ul>
 			<li><link href="rkward://rhelp/mean"/></li>
+			<li><link href="rkward://rhelp/sd"/></li>
+			<li><link href="rkward://rhelp/median"/></li>
+			<li><link href="rkward://rhelp/mad"/></li>
+			<li><link href="rkward://rhelp/range"/></li>
+			<li><link href="rkward://rhelp/sum"/></li>
+			<li><link href="rkward://rhelp/prod"/></li>
+			<li><link href="rkward://rhelp/length"/></li>
+			<li><link href="rkward://rhelp/NA"/></li>
 			<li><link href="rkward://component/basic_statistics"/></li>
-			<li><link href="rkward://page/basic_functions"/></li>
 		</ul>
 	</related>
 </document>

Modified: trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.xml
===================================================================
--- trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.xml	2007-01-08 16:23:28 UTC (rev 1098)
+++ trunk/rkward/rkward/plugins/descriptive/descriptive_statistics.xml	2007-01-08 16:41:50 UTC (rev 1099)
@@ -28,7 +28,7 @@
 			</tab>
 			<tab label="Median, MAD" id="tab_median_mad">
 				<column>
-					<frame label="Median, Range" >
+					<frame label="Median" >
 						<checkbox value_unchecked="0" value="1" id="median" label="median" />
 					</frame>
 					<frame label="Median Absolute Deviation (mad)" >


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