[rkward-cvs] SF.net SVN: rkward:[3075] trunk/rkward/rkward/rbackend/rpackages/rkward/man /rk.call.plugin.Rd

[tfry at users.sourceforge.net]

Revision: 3075
          http://rkward.svn.sourceforge.net/rkward/?rev=3075&view=rev
Author:   tfry
Date:     2010-09-25 10:55:26 +0000 (Sat, 25 Sep 2010)

Log Message:
-----------
Clarify synchrony and context of evaluation

Modified Paths:
--------------
    trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd

Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd	2010-09-25 09:16:52 UTC (rev 3074)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd	2010-09-25 10:55:26 UTC (rev 3075)
@@ -15,7 +15,7 @@
 \arguments{
 \item{plugin}{character string, giving the name of the plugin to call. See Details.}
 \item{\dots}{arguments passed to the \code{plugin}}
-\item{submit.mode}{character string, specifying the submission mode: \code{"manual"} will open the plugin GUI and wait for the user to submit it manually, \code{"auto"} will try to submit the plugin, if it can be submitted with the current settings (i.e. if the "Submit"-button is enabled after applying all specified parameters). If the plugin cannot be submitted, with the current settings, it will behave like \code{"manual"}. \code{"submit"} is like \code{"auot"}, but will  close the plugin, and generate an error, if it cannot be submitted..}
+\item{submit.mode}{character string, specifying the submission mode: \code{"manual"} will open the plugin GUI and leave it to the user to submit it manually, \code{"auto"} will try to submit the plugin, if it can be submitted with the current settings (i.e. if the "Submit"-button is enabled after applying all specified parameters). If the plugin cannot be submitted, with the current settings, it will behave like \code{"manual"}. \code{"submit"} is like \code{"auot"}, but will  close the plugin, and generate an error, if it cannot be submitted. \code{"manual"} will always return immediately, \code{"auto"} may or may not return immediately, and \code{"submit"} will always wait until the plugin has been run, or produce an error.}
 }
 
 \details{
@@ -23,6 +23,8 @@
 
 \bold{Warning}: Using \code{rk.call.plugin}, especially with submit.modes \code{"auto"} or \code{"submit"} to program a sequence of analyses has important drawbacks. First, the semantics of plugins are not guaranteed to remain unchanged across different versions of RKWard, thus your code may stop working after an upgrade. Second, your code will not be usable outside of an RKWard session. Consider copying the generated code for each plugin, instead. The primary use-cases for \code{rk.call.plugin} are automated tests, cross-references, and scripted tutorials.
 
+\bold{Note}: Even when using \code{"submit.mode=submit"}, the plugin code is run in the global context. Any local variables of the calling context are not available to the plugin.
+
 \code{rk.list.plugins} returns the list of the names of all currently registered plugins.
 }
 


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