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

[tfry at users.sourceforge.net]

Revision: 1318
          http://svn.sourceforge.net/rkward/?rev=1318&view=rev
Author:   tfry
Date:     2007-02-05 03:02:48 -0800 (Mon, 05 Feb 2007)

Log Message:
-----------
Documentation for plot_options (Prasenjit Kapat)

Modified Paths:
--------------
    trunk/rkward/rkward/plugins/plots/plot_options.xml

Added Paths:
-----------
    trunk/rkward/rkward/plugins/plots/plot_options.rkh

Added: trunk/rkward/rkward/plugins/plots/plot_options.rkh
===================================================================
--- trunk/rkward/rkward/plugins/plots/plot_options.rkh	                        (rev 0)
+++ trunk/rkward/rkward/plugins/plots/plot_options.rkh	2007-02-05 11:02:48 UTC (rev 1318)
@@ -0,0 +1,41 @@
+<!DOCTYPE rkhelp>
+<document>
+	<summary>
+		Generic plot options plugin. More often than not, this plugin is embeded into other plugins. As a result, not all the features explained here are available in a specific embeded situation. When a particular feature is available, it is explained as below.
+	</summary>
+
+	<usage>
+		Set or change the various graphical paramters to the plot function.
+	</usage>
+
+	<settings>
+		<caption id="titlepage"/>
+		<setting id="main">This is the <i>main</i> argument to plot.default. See R reference on <b>plot.default</b>.</setting>
+		<setting id="mainisexp">Check this box to evaluate the <i>main</i> title as an R expression.</setting>
+		<setting id="sub">This is the <i>sub</i> argument to plot.default. See R reference on <b>plot.default</b>.	</setting>
+		<setting id="subisexp">Check this box to evaluate the <i>sub</i> title as an R expression.</setting>
+
+		<caption id="axespage"/>
+		<setting id="xaxt">Uncheck this box to avoid drawing the X axis. This is the <i>xaxt</i> argument to par. See R reference on <b>par</b>.</setting>
+		<setting id="yaxt">Uncheck this box to avoid drawing the Y axis. This is the <i>yaxt</i> argument to par. See R reference on <b>par</b>.</setting>
+		<setting id="xlog">This specifies the <i>log</i> argument to plot.default. Check this box to set <i>log="x"</i>. See R reference on <b>plot.default</b>.</setting>
+		<setting id="ylog">This specifies the <i>log</i> argument to plot.default. Check this box to set <i>log="y"</i>. Check both the boxes to set <i>log="xy"</i>. See R reference on <b>plot.default</b>.</setting>
+
+		<setting id="axislabels">The X and Y axis labels. These are the <i>xlab</i> and <i>ylab</i> arguments to <b>plot.default</b>, respectively. The checkboxes enable or disable the labels being evaluated as R expressions.</setting>
+		<setting id="scale">The X and Y axis limits. These are the <i>xlim</i> and <i>ylim</i> arguments to <b>plot.default</b> respectively. For automatic evaluation of the limits, leave these blank.</setting>
+
+		<caption id="pointtypepage"/>
+		<setting id="pointtype">Choose one of the listed point/line types for the plot. To let the calling function use its default plotting type, choose the 'default' option. This is the <i>type</i> argument to <b>plot.default</b>.</setting>
+
+		<caption id="aspectratio"/>
+		<setting id="asp">This is the <i>asp</i> argument to <b>plot.default</b>.</setting>
+	</settings>
+
+	<related>
+		<ul>
+			<li><link href="rkward://rhelp/plot"/></li>
+			<li><link href="rkward://rhelp/plot.default"/></li>
+			<li><link href="rkward://rhelp/par"/></li>
+		</ul>
+	</related>
+</document>

Modified: trunk/rkward/rkward/plugins/plots/plot_options.xml
===================================================================
--- trunk/rkward/rkward/plugins/plots/plot_options.xml	2007-02-05 11:01:27 UTC (rev 1317)
+++ trunk/rkward/rkward/plugins/plots/plot_options.xml	2007-02-05 11:02:48 UTC (rev 1318)
@@ -1,6 +1,7 @@
 <!DOCTYPE rkplugin>
 <document>
 	<code file="plot_options.php" />
+	<help file="plot_options.rkh" />
 	<logic>
 		<external id="xvar" default="" />
 		<external id="yvar" default="" />
@@ -9,7 +10,7 @@
 		<external id="allow_aspect" default="false" />
 		<external id="allow_xlim" default="true" />
 		<external id="allow_ylim" default="true" />
-		
+
 		<convert id="no_xvar" mode="equals" sources="xvar" standard="" />
 		<convert id="no_yvar" mode="equals" sources="yvar" standard="" />
 
@@ -41,7 +42,7 @@
 
 		<convert id="ylabfilled" mode="notequals" sources="ylab.text" standard="" />
 		<connect client="ylabisexp.enabled" governor="ylabfilled" />
-		
+
 		<connect client="xlog.visible" governor="allow_log"/>
 		<connect client="ylog.visible" governor="allow_log"/>
 		<connect client="aspectratio.visible" governor="allow_aspect"/>
@@ -49,7 +50,7 @@
 	</logic>
 	<dialog label="Default plot options" >
 		<tabbook>
-			<tab label="Title">
+			<tab  id="titlepage" label="Title">
 				<column>
 					<frame label="Main title">
 						<input id="main" label="Main title (on top). Leave empty for default title" />
@@ -62,7 +63,7 @@
 					<stretch/>
 				</column>
 			</tab>
-			<tab label="Axes" >
+			<tab id="axespage" label="Axes" >
 				<column>
 					<frame id="axistypes" label="Axis types">
 						<row>


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