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

[tfry at users.sourceforge.net]

Revision: 1777
          http://svn.sourceforge.net/rkward/?rev=1777&view=rev
Author:   tfry
Date:     2007-04-02 07:58:43 -0700 (Mon, 02 Apr 2007)

Log Message:
-----------
Rename Simple Plot to Generic Plot, and add some explanation on what this means

Modified Paths:
--------------
    trunk/rkward/rkward/plugins/plots/plot.rkh
    trunk/rkward/rkward/plugins/plots/plot.xml
    trunk/rkward/rkward/plugins/under_development.pluginmap

Modified: trunk/rkward/rkward/plugins/plots/plot.rkh
===================================================================
--- trunk/rkward/rkward/plugins/plots/plot.rkh	2007-04-01 18:02:36 UTC (rev 1776)
+++ trunk/rkward/rkward/plugins/plots/plot.rkh	2007-04-02 14:58:43 UTC (rev 1777)
@@ -5,13 +5,15 @@
 	</summary>
 	<usage>
 		Choose the X and Y variables and customize the options to draw the plot.
+
+		Note: <b>plot</b> is a generic function. The type of plot you will actually get depends on the type of the input variables. For instance, for numeric vectors a scatterplot is produced (see below), while for data.frames as scatterplot matrix is plotted, etc. This is often useful to provide a meaningful visualization of the data, but does not allow for fine grained control.
 	</usage>
 	<settings>
 		<caption id="tab_variables"/>
 		<setting id="xvarslot">This is the <i>x</i> argument. And it is required to draw any plot. In the simplest case of plotting variables of class type integer/numeric, when "Y Variable" is not provided, this is actually the y-coordinate and the indices of the plotting variable is taken as the x-coordinate. See R reference on 'plot' for more details.</setting>
-		<setting id="yvarslot">This is the <i>y</i> argument.</setting>
+		<setting id="yvarslot">This is the <i>y</i> argument. Note that this is not always needed, and does not have an effect for some types of x variables.</setting>
 		<caption id="tab_options"/>
-		<setting id="plotoptions">Further generic plot options. Refer to <link href="rkward://component/plot_options"/> for details.</setting>
+		<setting id="plotoptions">Further generic plot options. Refer to <link href="rkward://component/plot_options"/> for details. Note that some of these settings may not have an effect, depending on the type of plot actually produced.</setting>
 	</settings>
 	<related>
 		<ul>

Modified: trunk/rkward/rkward/plugins/plots/plot.xml
===================================================================
--- trunk/rkward/rkward/plugins/plots/plot.xml	2007-04-01 18:02:36 UTC (rev 1776)
+++ trunk/rkward/rkward/plugins/plots/plot.xml	2007-04-02 14:58:43 UTC (rev 1777)
@@ -7,7 +7,7 @@
 		<set id="plotoptions.allow_aspect" to="true"/>
 		<set id="plotoptions.allow_grid" to="true"/>
 	</logic>
-	<dialog label="Plot" >
+	<dialog label="Generic Plot">
 		<tabbook>
 			<tab label="Variables" id="tab_variables">
 				<row>

Modified: trunk/rkward/rkward/plugins/under_development.pluginmap
===================================================================
--- trunk/rkward/rkward/plugins/under_development.pluginmap	2007-04-01 18:02:36 UTC (rev 1776)
+++ trunk/rkward/rkward/plugins/under_development.pluginmap	2007-04-02 14:58:43 UTC (rev 1777)
@@ -2,7 +2,7 @@
 
 <document base_prefix="" namespace="rkward">
 	<components>
-		<component type="standard" id="plot" file="plots/plot.xml" label="Simple Plot" />
+		<component type="standard" id="plot" file="plots/plot.xml" label="Generic Plot" />
 	</components>
 
 	<hierarchy>


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