[rkward-cvs] SF.net SVN: rkward:[4327] trunk/rkward/rkward/rbackend/rpackages/rkward/man
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sat Sep 29 15:11:13 UTC 2012
Revision: 4327
http://rkward.svn.sourceforge.net/rkward/?rev=4327&view=rev
Author: m-eik
Date: 2012-09-29 15:11:12 +0000 (Sat, 29 Sep 2012)
Log Message:
-----------
updated docs in rkward package (roxygen2)
Modified Paths:
--------------
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.replace.function.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
Added Paths:
-----------
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,45 +1,72 @@
-\name{rk.call.plugin}
+\name{rk.list.plugins}
\alias{rk.call.plugin}
\alias{rk.list.plugins}
-
\title{Call or list built-in RKWard plugin(s)}
+\usage{
+ rk.list.plugins()
-\description{
+ rk.call.plugin(plugin, ...,
+ submit.mode = c("manual", "auto", "submit"))
}
-
-\usage{
-rk.call.plugin(plugin, ..., submit.mode = c("manual", "auto", "submit"))
-rk.list.plugins(path, type = "all")
-}
-
\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 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.}
-}
+ \item{plugin}{character string, giving the name of the
+ plugin to call. See Details.}
-\details{
-\code{rk.call.plugin} provides a high level wrapper to call any plugin available in RKWard. The exact string to be used as \code{plugin}, and the list of arguments available for a particular plugin, are generally not transparent to the user.\code{rk.list.plugins} can be used to obtain a list of current plugins. For plugin arguments, it is recommended to run the plugin, and inspect the "Run again" link that is generated on the output.
+ \item{\dots}{arguments passed to the \code{plugin}}
-\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.
+ \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.}
}
-
\value{
-\code{rk.call.plugin} returns \code{TRUE} invisibly.
+ \code{rk.call.plugin} returns \code{TRUE} invisibly.
-\code{rk.list.plugins} returns a character vector of plugin names. If none found, \code{NULL} is returned.
+ \code{rk.list.plugins} returns a character vector of
+ plugin names. If none found, \code{NULL} is returned.
}
+\description{
+ \code{rk.call.plugin} provides a high level wrapper to
+ call any plugin available in RKWard. The exact string to
+ be used as \code{plugin}, and the list of arguments
+ available for a particular plugin, are generally not
+ transparent to the user.\code{rk.list.plugins} can be
+ used to obtain a list of current plugins. For plugin
+ arguments, it is recommended to run the plugin, and
+ inspect the "Run again" link that is generated on the
+ output.
+}
+\details{
+ \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.
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+ \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.
-\seealso{
-\code{\link{rk.results}}, \url{rkward://page/rkward_output}
+ \code{rk.list.plugins} returns the list of the names of
+ all currently registered plugins.
}
-
\examples{
## list all current plugins
rk.list.plugins ()
@@ -50,11 +77,19 @@
x1 <- rnorm (100)
x2 <- rnorm (100, 2)
-rk.call.plugin ("rkward::t_test_two_vars",
- confint.state="1", conflevel.real="0.95", hypothesis.string="greater", paired.state="0", varequal.state="0",
- x.available="x1", y.available="x2",
+rk.call.plugin ("rkward::t_test_two_vars",
+ confint.state="1", conflevel.real="0.95", hypothesis.string="greater", paired.state="0", varequal.state="0",
+ x.available="x1", y.available="x2",
submit.mode="submit")
})
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \code{\link{rk.results}},
+ \url{rkward://page/rkward_output}
+}
+\keyword{utilities}
-\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,36 +1,39 @@
\name{rk.demo}
\alias{rk.demo}
-
\title{Opens an R demo script for editing}
-
\usage{
-rk.demo(topic, package=NULL, lib.loc=NULL)
+ rk.demo(topic, package = NULL, lib.loc = NULL)
}
-
\arguments{
\item{topic}{topic of the example}
- \item{package}{package(s) to search for the demo. If NULL (the default), all currently loaded packages are searched.}
+
+ \item{package}{package(s) to search for the demo. If NULL
+ (the default), all currently loaded packages are
+ searched.}
+
\item{lib.loc}{Library locations.}
}
-
-\details{
- \code{rk.demo} behaves similar to \code{\link{demo}}, but opens the demo script for editing, instead of sourcing it. Contrary to \code{\link{demo}}, the specification of a topic is mandatory.
-}
-
\value{
Return \code{NULL}, unconditionally.
}
-
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
-\seealso{
- \code{\link{rk.edit.files}}, \code{\link{rk.show.files}}, \code{\link{demo}}
+\description{
+ \code{rk.demo} behaves similar to \code{\link{demo}}, but
+ opens the demo script for editing, instead of sourcing
+ it. Contrary to \code{\link{demo}}, the specification of
+ a topic is mandatory.
}
-
\examples{
## Not run
rk.demo("graphics")
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \code{\link{rk.edit.files}}, \code{\link{rk.show.files}},
+ \code{\link{demo}}
+}
+\keyword{IO}
+\keyword{utilities}
-\keyword{utilities}
-\keyword{IO}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -3,46 +3,71 @@
\alias{rk.edit.files}
\alias{rk.show.files}
\alias{rk.show.html}
-
\title{Edit / show an object / file}
+\usage{
+ rk.edit(x)
-\usage{
-rk.edit(x)
-rk.edit.files(file = file, title = file, name = NULL, prompt = TRUE)
-rk.show.files(file = file, title = file, wtitle = NULL, delete = FALSE, prompt = TRUE)
-rk.show.html(url)
+ rk.edit.files(file = file, title = file, name = NULL,
+ prompt = TRUE)
+
+ rk.show.files(file = file, title = file, wtitle = NULL,
+ delete = FALSE, prompt = TRUE)
+
+ rk.show.html(url)
}
-
\arguments{
\item{x}{an object to edit.}
+
\item{file}{character vector, filenames to show or edit.}
- \item{title}{character vector, of the same length as \code{file}; This can be used to give descriptive titles to each file, which will be displayed to the user.}
- \item{wtitle}{character vector, of length 1. This will be used as the window title.}
- \item{prompt}{logical of length 1. If TRUE (the default) a prompt is dialog is shown along with the files to show / edit.}
- \item{delete}{a logical (not NA), when \code{TRUE} the shown file(s) are deleted after closing.}
-}
-\details{
- \code{rk.edit} can be used to edit an object in the RKWard data editor. Currently only \link{data.frame}s are supported. This is similar to \link{edit.data.frame}, but the function returns immediately, and the object is edit asynchronously.
+ \item{title}{character vector, of the same length as
+ \code{file}; This can be used to give descriptive titles
+ to each file, which will be displayed to the user.}
- \code{rk.edit.files}, \code{rk.show.files}, and \code{rk.show.html} are equivalent to \link{file.edit}, \link{file.show}, and \link{browseURL}, respectively, but use RKWard as text/html editor/viewer. Generally it is recommended to use \link{file.edit}, \link{file.show}, and \link{browseURL}, instead. These will call the respective RKWard functions by default, when run inside an RKWard session.
+ \item{wtitle}{character vector, of length 1. This will be
+ used as the window title.}
+
+ \item{prompt}{logical of length 1. If TRUE (the default)
+ a prompt is dialog is shown along with the files to show
+ / edit.}
+
+ \item{delete}{a logical (not NA), when \code{TRUE} the
+ shown file(s) are deleted after closing.}
}
-
\value{
- All functions described on this page return \code{NULL}, unconditionally.
+ All functions described on this page return \code{NULL},
+ unconditionally.
}
-
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
-\seealso{
- \code{\link{edit}}, \code{\link{file.edit}}, \code{\link{file.show}}, \code{\link{browseURL}}
+\description{
+ \code{rk.edit} can be used to edit an object in the
+ RKWard data editor. Currently only \link{data.frame}s are
+ supported. This is similar to \link{edit.data.frame}, but
+ the function returns immediately, and the object is edit
+ asynchronously.
}
-
+\details{
+ \code{rk.edit.files}, \code{rk.show.files}, and
+ \code{rk.show.html} are equivalent to \link{file.edit},
+ \link{file.show}, and \link{browseURL}, respectively, but
+ use RKWard as text/html editor/viewer. Generally it is
+ recommended to use \link{file.edit}, \link{file.show},
+ and \link{browseURL}, instead. These will call the
+ respective RKWard functions by default, when run inside
+ an RKWard session.
+}
\examples{
## Not run
x <- data.frame (a=c(1:3), b=c(2:4))
rk.edit(x)
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \code{\link{edit}}, \code{\link{file.edit}},
+ \code{\link{file.show}}, \code{\link{browseURL}}
+}
+\keyword{IO}
+\keyword{utilities}
-\keyword{utilities}
-\keyword{IO}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,47 +1,63 @@
\name{rk.get.tempfile.name}
-
+\alias{rk.get.output.html.file}
\alias{rk.get.tempfile.name}
\alias{rk.get.workspace.url}
-\alias{rk.get.output.html.file}
\alias{rk.set.output.html.file}
-
\title{RKWard file names}
+\usage{
+ rk.get.tempfile.name(prefix = "image",
+ extension = ".jpg")
-\usage{
-rk.get.tempfile.name(prefix="image", extension=".jpg")
-rk.get.workspace.url()
-rk.get.output.html.file()
-rk.set.output.html.file(x)
+ rk.get.workspace.url()
+
+ rk.get.output.html.file()
+
+ rk.set.output.html.file(x)
}
-
\arguments{
- \item{prefix}{a string, used as a filename prefix when saving images to the output file}
- \item{extension}{a string, used as a filename extension when saving images to the output file}
- \item{x}{a string, giving the filename of the of the output file}
-}
+ \item{prefix}{a string, used as a filename prefix when
+ saving images to the output file}
-\details{
- In RKWard the output is saved as a html file which is located at "~/.rkward" by default. (\bold{TODO}: make this platform free). The name of this html file can be retrieved and set using \code{rk.get.output.html.file} and \code{rk.set.output.html.file}.
+ \item{extension}{a string, used as a filename extension
+ when saving images to the output file}
- \code{rk.get.tempfile.name} returns a non-existing filename inside the directory of the output file. It is mainly used by \link{rk.graph.on} to create filenames suitable for storing images in the output. The filenames of the temporary files are of the form "\code{prefix}\emph{xyz}.\code{extension}". \code{rk.get.tempfile.name} is somewhat misnamed. For truly temporary files, \link{tempfile} is generally more suitable.
-
- \code{rk.get.workspace.url} returns the url of workspace file which has been loaded in RKWard, or NULL, if no workspace has been loaded. NOTE: This value is note affected by running \code{load} in R, only by loading R workspaces via the RKWard GUI.
+ \item{x}{a string, giving the filename of the of the
+ output file}
}
-
\value{
- \code{rk.get.tempfile.name}, \code{rk.get.output.html.file}, and \code{rk.get.workspace.url} return a string while \code{rk.set.output.html.file} returns \code{NULL}.
+ \code{rk.get.tempfile.name},
+ \code{rk.get.output.html.file}, and
+ \code{rk.get.workspace.url} return a string while
+ \code{rk.set.output.html.file} returns \code{NULL}.
}
+\description{
+ In RKWard the output is saved as a html file which is
+ located at "~/.rkward" by default. (\bold{TODO}: make
+ this platform free). The name of this html file can be
+ retrieved and set using \code{rk.get.output.html.file}
+ and \code{rk.set.output.html.file}.
+}
+\details{
+ \code{rk.get.tempfile.name} returns a non-existing
+ filename inside the directory of the output file. It is
+ mainly used by \link{rk.graph.on} to create filenames
+ suitable for storing images in the output. The filenames
+ of the temporary files are of the form
+ "\code{prefix}\emph{xyz}.\code{extension}".
+ \code{rk.get.tempfile.name} is somewhat misnamed. For
+ truly temporary files, \link{tempfile} is generally more
+ suitable.
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
-\seealso{
-\url{rkward://page/rkward_output}, \link{tempfile}, \link{file}, \link{rk.print}
+ \code{rk.get.workspace.url} returns the url of workspace
+ file which has been loaded in RKWard, or NULL, if no
+ workspace has been loaded. NOTE: This value is note
+ affected by running \code{load} in R, only by loading R
+ workspaces via the RKWard GUI.
}
-
\examples{
testfile.name <- rk.get.tempfile.name(prefix="test", extension=".txt")
testfile <- file(testfile.name)
-cat("This is a test\n", file=testfile)
+cat("This is a test\\n", file=testfile)
close(testfile)
unlink(testfile.name)
@@ -53,6 +69,14 @@
rk.show.html(rk.get.output.html.file())
rk.set.output.html.file(outfile)
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \url{rkward://page/rkward_output}, \link{tempfile},
+ \link{file}, \link{rk.print}
+}
+\keyword{IO}
+\keyword{utilities}
-\keyword{utilities}
-\keyword{IO}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -0,0 +1,105 @@
+\name{rk.get.label}
+\alias{rk.get.description}
+\alias{rk.get.label}
+\alias{rk.get.short.name}
+\alias{rk.list}
+\alias{rk.list.labels}
+\alias{rk.list.names}
+\alias{.rk.make.short.name}
+\alias{rk.set.label}
+\title{Various label related utility functions}
+\usage{
+ rk.get.label(x)
+
+ rk.set.label(x, label, envir = parent.frame())
+
+ rk.list.labels(x, fill = FALSE)
+
+ rk.get.short.name(x)
+
+ .rk.make.short.name(x)
+
+ rk.get.description(..., paste.sep = NULL,
+ is.substitute = FALSE)
+
+ rk.list(...)
+
+ rk.list.names(..., deparse.level = 2)
+}
+\arguments{
+ \item{x}{any R object}
+
+ \item{label}{a string, to set the label attribute of an
+ object}
+
+ \item{envir}{an environment, where the attribute is
+ evaluated}
+
+ \item{fill}{a logical or character. See Details.}
+
+ \item{paste.sep}{a string, used as the \code{collapse}
+ argument for paste}
+
+ \item{is.substitute}{a logical (not NA). See Details.}
+}
+\value{
+ \code{rk.set.label} returns the result of the evaluation
+ of "setting the label" while the others return a
+ character vector.
+}
+\description{
+ \code{rk.get.label} retrieves the rkward label (if any)
+ of the given object.
+}
+\details{
+ \code{rk.set.label} sets the rkward label for the given
+ object.
+
+ \code{rk.list.labels} retrieves the rkward labels for a
+ list of objects. Most importantly, this can be used for
+ extracting all column labels in a \code{data.frame},
+ conveniently. The parameter \code{fill} controls, what
+ happens, when no rkward labels have been assigned. The
+ default (\code{FALSE}) is to return empty strings for any
+ missing labels. For \code{fill=TRUE}, missing labels will
+ be filled with the short names of the object. You can
+ also pass a character vector of default labels to use as
+ the \code{fill} parameter.
+
+ \code{rk.get.short.name} creates a short name for the
+ given object.
+
+ \code{rk.get.description} creates descriptive string(s)
+ for each of the arguments in "\code{\dots{}}"; collapsing
+ into a single string using \code{paste.sep} (if not
+ NULL). If \code{is.substitute=TRUE}, the arguments will
+ be deparsed, first, which can be useful when using
+ \code{rk.get.description} inside a function.
+
+ \code{rk.list.names} returns the names of the arguments
+ passed as \code{...}; when using \code{rk.list.names}
+ inside a function, it may be necessary to increase the
+ \code{deparse.level} level.
+
+ \code{rk.list} returns a list of its arguments, with
+ \code{names} set as returned by
+ \code{rk.get.description()}. This can be used as a
+ drop-in replacement for \code{\link{list}}.
+}
+\examples{
+x <- data.frame(a=c(1:3), b=c(2:4))
+rk.set.label(x[["a"]], "First column")
+rk.get.short.name (x$a) # "x$a"
+rk.get.label (x$a) # "First column"
+rk.get.description (x$a) # "x$a (First column)"
+rk.list.labels (x) # "First column" ""
+rk.list.labels (x, TRUE) # "First column" "b"
+rk.list.names (x, x$a, x$b) # "x" "x$a" "x$b"
+names (rk.list (x$a, x$b)) # "x$a (First column)" "x$b"
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\keyword{utilities}
+
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,6 +1,10 @@
\name{rk.load.pluginmaps}
\alias{rk.load.pluginmaps}
\title{(Re-)load the given pluginmap files into the RKWard GUI}
+\usage{
+ rk.load.pluginmaps(pluginmap.files = NULL,
+ force.add = TRUE, force.reload = TRUE)
+}
\arguments{
\item{pluginmap.files}{a character vector of file names
to add. This may be left empty, if the only desired
@@ -22,7 +26,7 @@
\bold{Note}: It is not necessary to reload the pluginmap,
in order to refresh an individual plugin (e.g. after
modifying the dialog), as plugins are not kept in memory
- after closing. Any currently opened plugins are not
+ after closing. Any currently opened plugins are not
affected by this function.}
}
\description{
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,45 +1,53 @@
-\name{RKWard_misc}
+\name{rk.rename.in.container}
+\alias{rk.make.repos.string}
\alias{rk.misc}
\alias{rk.rename.in.container}
-\alias{rk.make.repos.string}
\alias{rk.select.CRAN.mirror}
-
\title{Miscellaneous utility functions}
+\usage{
+ rk.rename.in.container(x, old_name, new_name,
+ envir = parent.frame())
-\description{
-}
+ rk.make.repos.string()
-\usage{
-rk.rename.in.container(x, old_name, new_name, envir = parent.frame())
-rk.make.repos.string()
-rk.select.CRAN.mirror()
+ rk.select.CRAN.mirror()
}
-
\arguments{
-\item{x}{a data.frame or list.}
-\item{old_name}{a string, the name of the column or element to be renamed.}
-\item{new_name}{a string, the new name.}
-\item{envir}{an environment where \code{x} is available.}
-}
+ \item{x}{a data.frame or list.}
-\details{
-\code{rk.rename.in.container} renames a named object (column/element) in a data.frame/list without changing its position.
+ \item{old_name}{a string, the name of the column or
+ element to be renamed.}
-\code{rk.make.repos.string} just creates a R statement for \code{repos}. A typical user should not need to use this function.
+ \item{new_name}{a string, the new name.}
-\code{rk.select.CRAN.mirror} is an in-house replacement for \code{\link{chooseCRANmirror}} without changing \code{options ("repos")}, permanently. It uses native KDE gui and provides more information on each mirror.
+ \item{envir}{an environment where \code{x} is available.}
}
-
\value{
-\code{rk.rename.in.container} returns \code{NULL} on successfule renaming, otherwise an error.
+ \code{rk.rename.in.container} returns \code{NULL} on
+ successfule renaming, otherwise an error.
-\code{rk.make.repos.string} returns a valid R expression as a character string which can then be parsed and evaluated.
+ \code{rk.make.repos.string} returns a valid R expression
+ as a character string which can then be parsed and
+ evaluated.
-\code{rk.select.CRAN.mirror} returns the URL of the chosen mirror, as a string.
+ \code{rk.select.CRAN.mirror} returns the URL of the
+ chosen mirror, as a string.
}
+\description{
+ \code{rk.rename.in.container} renames a named object
+ (column/element) in a data.frame/list without changing
+ its position.
+}
+\details{
+ \code{rk.make.repos.string} just creates a R statement
+ for \code{repos}. A typical user should not need to use
+ this function.
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
+ \code{rk.select.CRAN.mirror} is an in-house replacement
+ for \code{\link{chooseCRANmirror}} without changing
+ \code{options ("repos")}, permanently. It uses native KDE
+ gui and provides more information on each mirror.
+}
\examples{
## rk.rename.in.container
ir <- iris
@@ -47,7 +55,11 @@
rk.rename.in.container(ir, "Species", "Taxonomic.Group")
str (ir)
}
-
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
\keyword{attribute}
\keyword{misc}
\keyword{utilities}
+
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -0,0 +1,39 @@
+\name{rk.old.packages}
+\alias{rk.old.packages}
+\title{Slightly smarter variant of old.packages()}
+\usage{
+ rk.old.packages(lib.loc = NULL,
+ repos = getOption("repos"),
+ contriburl = contrib.url(repos, type),
+ instPkgs = installed.packages(lib.loc = lib.loc),
+ method, available = NULL, checkBuilt = FALSE,
+ type = getOption("pkgType"))
+}
+\value{
+ a character vector of packages which are really old
+}
+\description{
+ For most purposes, this function is identical to
+ old.packages(). However, if the same package is installed
+ to different locations, in different versions,
+ old.packages() will treat each of these installations
+ separately. Thus, e.g. if lib.loc == c("A", "B") and
+ package X is installed in B at an outdated version 0.1,
+ but in A at the most recent version 0.2, old.packages()
+ will report package X at B as old. In contrast
+ rk.old.packages() will recognize that the current version
+ is higher up in the path, and not report package X as
+ old.
+}
+\examples{
+## NOT RUN
+rk.old.packages()
+}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\keyword{attribute}
+\keyword{misc}
+\keyword{utilities}
+
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,39 +1,40 @@
\name{rk.printer.device}
\alias{rk.printer.device}
-
\title{Device for printing using the KDE print dialog}
-
-\description{
-Creates a device operating on a temporary file (internally a \code{\link{postscript}}() device). When the device is closed, it is printed, automatically, using the KDE print dialog (if installed).
-}
-
\usage{
-rk.printer.device(...)
+ rk.printer.device(...)
}
-
\arguments{
-\item{...}{arguments are passed to \code{\link{postscript}}}
+ \item{...}{arguments are passed to
+ \code{\link{postscript}}}
}
-
+\value{
+ Returns the name of the underlying temporary file,
+ invisibly.
+}
+\description{
+ Creates a device operating on a temporary file
+ (internally a \code{\link{postscript}}() device). When
+ the device is closed, it is printed, automatically, using
+ the KDE print dialog (if installed).
+}
\details{
-Typically this device is used with \code{\link{dev.print}}, as shown in the example, below.
+ Typically this device is used with
+ \code{\link{dev.print}}, as shown in the example, below.
}
-
-\value{
-Returns the name of the underlying temporary file, invisibly.
-}
-
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
\examples{
## Not run:
plot (rnorm (10))
dev.print (rk.printer.device)
}
-
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
\seealso{
- \code{\link{postscript}}, \code{\link{dev.print}}, \code{\link{rk.graph.on}}
+ \code{\link{postscript}}, \code{\link{dev.print}},
+ \code{\link{rk.graph.on}}
}
+\keyword{device}
+\keyword{utilities}
-\keyword{utilities}
-\keyword{device}
Added: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd (rev 0)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -0,0 +1,21 @@
+\name{rk.record.commands}
+\alias{rk.record.commands}
+\title{Start recording commands that are submitted from RKWard to R}
+\usage{
+ rk.record.commands(filename, include.all = FALSE)
+}
+\arguments{
+ \item{filename}{filename to write to (file will be
+ truncated!).}
+
+ \item{include.all}{By default, some types of command are
+ filtered (internal synchronisation commands, and run
+ again links). Should these be included?}
+}
+\description{
+ To stop recording, supply NULL or "" as filename.
+ Currently used for the purpose of automated testing,
+ only. Perhaps in the future this or a similar mechanism
+ could also be added as a user feature.
+}
+
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.replace.function.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.replace.function.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.replace.function.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,48 +1,63 @@
\name{rk.replace.function}
\alias{rk.replace.function}
-
\title{Replace a function inside its package environment / namespace}
-
\usage{
-rk.replace.function(functionname, environment, replacement, copy.formals=TRUE)
+ rk.replace.function(functionname, environment,
+ replacement, copy.formals = TRUE)
}
-
\arguments{
- \item{functionname}{name of the function to be replaced (character).}
- \item{environment}{package environment or namespace, where replacment should be done.}
- \item{replacement}{the replacement. This should be a function.}
- \item{copy.formals}{logical; whether to copy the \code{\link{formals}} from the original function.}
-}
+ \item{functionname}{name of the function to be replaced
+ (character).}
-\details{
- \code{rk.replace.function} can be used to replace a function inside a different package / namespace. It is mainly intended for internal usage inside rkward, e.g. to replace \code{menu} and \code{select.list} with appropriate GUI implementations.
+ \item{environment}{package environment or namespace,
+ where replacment should be done.}
- The original function is assigned to the environment \code{rkward::.rk.backups} with the same name as the original, and can be referred to from the replacement. WARNING: This mechansim does not support several subsequent replacments of the same function.
+ \item{replacement}{the replacement. This should be a
+ function.}
- WARNING: This function can be used to alter - and disrupt - internal functions in arbitrary ways. You better know what you are doing.
-
- WARNING: Does not work well on generics!
+ \item{copy.formals}{logical; whether to copy the
+ \code{\link{formals}} from the original function.}
}
-
\value{
Returns \code{NULL}, invisibly, unconditionally.
}
+\description{
+ \code{rk.replace.function} can be used to replace a
+ function inside a different package / namespace. It is
+ mainly intended for internal usage inside rkward, e.g. to
+ replace \code{menu} and \code{select.list} with
+ appropriate GUI implementations.
+}
+\details{
+ The original function is assigned to the environment
+ \code{rkward::.rk.backups} with the same name as the
+ original, and can be referred to from the replacement.
+ WARNING: This mechanism does not support several
+ subsequent replacments of the same function, nor does it
+ support replacement of generics.
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+ \bold{WARNING}: This function can be used to alter - and
+ disrupt - internal functions in arbitrary ways. You
+ better know what you are doing.
-\seealso{
- \code{\link{assignInNamespace}}, \code{\link{debug}}
+ \bold{WARNING}: Does not work well on generics!
}
-
\examples{
## Not run
rk.replace.function ("history", as.environment ("package:utils"),
function () {
- cat ("This is what you typed:\n")
+ cat ("This is what you typed:\\n")
eval (body (.rk.backups$history))
})
## End not run
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \code{\link{assignInNamespace}}, \code{\link{debug}}
+}
+\keyword{IO}
+\keyword{utilities}
-\keyword{utilities}
-\keyword{IO}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,60 +1,97 @@
-\name{rk.results}
+\name{rk.print}
+\alias{rk.describe.alternative}
+\alias{rk.header}
\alias{rk.print}
\alias{rk.print.code}
\alias{rk.print.literal}
-\alias{rk.header}
\alias{rk.results}
-\alias{rk.describe.alternative}
-
\title{Print objects and results to output}
+\usage{
+ rk.print(x, ...)
-\description{
- Various utilty functions which can be used to print or export R objects to the (html) output file. The output file can be accessed from Windows -> Show Output. Basically, these functions along with the ones described in \code{\link{rk.get.label}}, \code{\link{rk.get.tempfile.name}}, and \code{\link{rk.graph.on}} can be used to create a HTML report.
-}
+ rk.print.code(code)
-\usage{
-rk.print(x, ...)
-rk.print.literal(x)
-rk.print.code(code)
-rk.header(title, parameters = list(), level = 1)
-rk.results(x, titles = NULL, print.rownames)
-rk.describe.alternative(x)
+ rk.header(title, parameters = list(), level = 1,
+ toc = NULL)
+
+ rk.results(x, titles = NULL, print.rownames)
+
+ rk.print.literal(x)
+
+ rk.describe.alternative(x)
}
-
\arguments{
-\item{x}{any R object to be printed/exported. A suitable list in case of \code{rk.describe.alternative}.}
-\item{code}{a character vector (single string) of R code}
-\item{title}{a string, used as a header for the html output}
-\item{level}{an integer, header level. For example, \code{level=2} creates the header with \code{<h2></h>} tag.}
-\item{parameters}{a list, preferably named, giving a list of "parameters" to be printed to the output}
-\item{titles}{a character vector, giving the column headers for a html table.}
-\item{print.rownames}{controls printing of rownames. TRUE to force printing, FALSE to suppress printing, omitted (default) to print rownames, unless they are plain row numbers.}
-}
+ \item{x}{any R object to be printed/exported. A suitable
+ list in case of \code{rk.describe.alternative}.}
-\details{
-\code{rk.print} prints/exports the given object to the output (html) file using the \code{\link{HTML}} function. This requires the \code{R2HTML} package. Additional arguments in \code{...} are passed on to \code{\link{HTML}}.
+ \item{code}{a character vector (single string) of R code}
-\code{rk.print.literal} prints/exports the given object using a \code{paste(x, collapse="\n")} construct to the output (html) file.
+ \item{title}{a string, used as a header for the html
+ output}
-\code{rk.print.code} applies syntax highlighting to the given code string, and writes it to the output (html) file.
+ \item{level}{an integer, header level. For example,
+ \code{level=2} creates the header with \code{<h2></h>}
+ tag.}
-\code{rk.header} prints a header / caption, possibly with parameters, to the output file. See example.
+ \item{parameters}{a list, preferably named, giving a list
+ of "parameters" to be printed to the output}
-\code{rk.results} is similar to \code{rk.print} but prints in a more tabulated fashion. This has been implemented only for certain types of \code{x}: tables, lists (or data.frames), and vectors. See example.
+ \item{toc}{If \code{NULL}, the default,
+ \code{rk.header()} will automatically add headers h1 to
+ h4 to the TOC menu of the output document. \code{TRUE}
+ will always add the header, and \code{FALSE} will
+ suppress it.}
-\code{rk.describe.alternatives} describes the alternative (H1) hypothesis of a \code{htest}. This is similar to \code{stats:::print.htext} and makes sense only when \code{x$alternatives} exists.
+ \item{titles}{a character vector, giving the column
+ headers for a html table.}
+
+ \item{print.rownames}{controls printing of rownames. TRUE
+ to force printing, FALSE to suppress printing, omitted
+ (default) to print rownames, unless they are plain row
+ numbers.}
}
-
\value{
-\code{rk.describe.alternatives} returns a string while all other functions return \code{NULL}, invisibly.
+ \code{rk.describe.alternatives} returns a string while
+ all other functions return \code{NULL}, invisibly.
}
+\description{
+ Various utilty functions which can be used to print or
+ export R objects to the (html) output file. The output
+ file can be accessed from Windows -> Show Output.
+ Basically, these functions along with the ones described
+ in \code{\link{rk.get.label}},
+ \code{\link{rk.get.tempfile.name}}, and
+ \code{\link{rk.graph.on}} can be used to create a HTML
+ report.
+}
+\details{
+ \code{rk.print} prints/exports the given object to the
+ output (html) file using the \code{\link{HTML}} function.
+ This requires the \code{R2HTML} package. Additional
+ arguments in \code{...} are passed on to
+ \code{\link{HTML}}.
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+ \code{rk.print.literal} prints/exports the given object
+ using a \code{paste(x, collapse="\n")} construct to the
+ output (html) file.
-\seealso{
-\code{\link{HTML}}, \code{\link{rk.get.output.html.file}}, \code{\link{rk.get.description}}, \code{\link{rk.call.plugin}}, \url{rkward://page/rkward_output}
+ \code{rk.print.code} applies syntax highlighting to the
+ given code string, and writes it to the output (html)
+ file.
+
+ \code{rk.header} prints a header / caption, possibly with
+ parameters, to the output file. See example.
+
+ \code{rk.results} is similar to \code{rk.print} but
+ prints in a more tabulated fashion. This has been
+ implemented only for certain types of \code{x}: tables,
+ lists (or data.frames), and vectors. See example.
+
+ \code{rk.describe.alternatives} describes the alternative
+ (H1) hypothesis of a \code{htest}. This is similar to
+ \code{stats:::print.htext} and makes sense only when
+ \code{x$alternatives} exists.
}
-
\examples{
require (rkward)
require (R2HTML)
@@ -67,7 +104,7 @@
nm <- rk.get.description (x1,x2)
result <- t.test (x1, x2, alternative="less")
-rk.print.code ("result <- t.test (x1, x2, alternative=\"less\")")
+rk.print.code ("result <- t.test (x1, x2, alternative=\\"less\\")")
rk.header (result$method,
parameters=list ("Comparing", paste (nm[1], "against", nm[2]),
@@ -88,5 +125,16 @@
'confidence interval of difference'=result$conf.int ))
})
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \code{\link{HTML}},
+ \code{\link{rk.get.output.html.file}},
+ \code{\link{rk.get.description}},
+ \code{\link{rk.call.plugin}},
+ \url{rkward://page/rkward_output}
+}
+\keyword{utilities}
-\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,34 +1,34 @@
\name{rk.sessionInfo}
\alias{rk.sessionInfo}
-
\title{Print information on the RKWard session}
-
\usage{
-rk.sessionInfo()
+ rk.sessionInfo()
}
-
-\arguments{
+\value{
+ Returns the object created by \code{sessionInfo()},
+ invisibly. Note that this includes only the information
+ on the R portion of the session.
}
-
+\description{
+ Gathers and prints information on the setup of the
+ current RKWard session. In general, you should always
+ include this information when reporting a bug in RKWard.
+}
\details{
-Gathers and prints information on the setup of the current RKWard session. In general, you should always include this information when reporting a bug in RKWard.
-
-Typically, when reporting a bug, you should use \code{Help->Report Bug...} from the menu. Internally, this will call \code{rk.sessionInfo()}.
+ Typically, when reporting a bug, you should use
+ \code{Help->Report Bug...} from the menu. Internally,
+ this will call \code{rk.sessionInfo()}.
}
-
-\value{
-Returns the object created by \code{sessionInfo()}, invisibly. Note that this includes only the information on the R portion of the session.
+\examples{
+rk.sessionInfo()
}
-
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
\seealso{
-\code{\link{sessionInfo}}
+ \code{\link{sessionInfo}}
}
+\keyword{misc}
+\keyword{utilities}
-\examples{
-rk.sessionInfo()
-}
-
-\keyword{utilities}
-\keyword{misc}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,71 +1,101 @@
\name{rk.show.message}
+\alias{rk.select.list}
\alias{rk.show.message}
\alias{rk.show.question}
-\alias{rk.select.list}
-
\title{Message boxes and selection list using native KDE GUI}
+\usage{
+ rk.show.message(message, caption = "Information",
+ wait = TRUE)
-\description{
- Multi-purpose pop-up message boxes and selection list using native KDE GUI elements. The message boxes can be used either to show some information or ask some question. The selection list can be used to get a vector of selected items.
+ rk.show.question(message, caption = "Question",
+ button.yes = "yes", button.no = "no",
+ button.cancel = "cancel")
+
+ rk.select.list(list, preselect = NULL, multiple = FALSE,
+ title = NULL)
}
+\arguments{
+ \item{message}{a string for the content of the message
+ box.}
-\usage{
-rk.show.message (message, caption = "Information", wait = TRUE)
+ \item{caption}{a string for title of the message box.}
-rk.show.question (message, caption = "Question",
- button.yes = "yes", button.no = "no", button.cancel = "cancel")
+ \item{button.yes}{a string for the text label of the
+ \bold{Yes} button. Can be an empty string (\code{""}), in
+ which case the button is not displayed at all.}
-rk.select.list (list, preselect = NULL, multiple = FALSE, title = NULL)
-}
+ \item{button.no}{a string used for the text label of the
+ \bold{No} button, similar to \code{button.yes}.}
-\arguments{
- \item{message}{a string for the content of the message box.}
- \item{caption}{a string for title of the message box.}
- \item{button.yes}{a string for the text label of the \bold{Yes} button. Can be an empty string (\code{""}), in which case the button is not displayed at all.}
- \item{button.no}{a string used for the text label of the \bold{No} button, similar to \code{button.yes}.}
- \item{button.canel}{a string used for the text label of the \bold{Cancel} button, similar to \code{button.yes}.}
- \item{wait}{a logical (not NA) indicating whether the R interpreter should wait for the user's action, or run it asynchronously.}
+ \item{button.canel}{a string used for the text label of
+ the \bold{Cancel} button, similar to \code{button.yes}.}
+
+ \item{wait}{a logical (not NA) indicating whether the R
+ interpreter should wait for the user's action, or run it
+ asynchronously.}
+
\item{list}{a vector, coerced into a character vector.}
- \item{preselct}{a vector, coerced into a character vector, items to be preselected.}
- \item{multiple}{a logical (not NA), when \code{TRUE} multiple selection selection is allowed.}
- \item{title}{a string, for the window title of the displayed list}
-}
-\details{
- For \code{rk.show.question}, the R interpreter always waits for the user's choice.
-
- \code{rk.select.list} replaces \code{utils::select.list} for the running session acting as a drop-in replacement for \code{tk_select.list}. Use \code{.rk.backups$select.list} for the original \code{utils::select.list} function (see Examples).
+ \item{preselct}{a vector, coerced into a character
+ vector, items to be preselected.}
+
+ \item{multiple}{a logical (not NA), when \code{TRUE}
+ multiple selection selection is allowed.}
+
+ \item{title}{a string, for the window title of the
+ displayed list}
}
-
\value{
- \code{rk.show.message} always returns \code{TRUE}, invisibly.
-
- \code{rk.show.question} returns \code{TRUE} for \bold{Yes}, \code{FALSE} for \bold{No}, and \code{NULL} for \bold{Cancel} actions.
-
- \code{rk.select.list} returns the value of \code{\link{select.list}}.
-}
+ \code{rk.show.message} always returns \code{TRUE},
+ invisibly.
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
+ \code{rk.show.question} returns \code{TRUE} for
+ \bold{Yes}, \code{FALSE} for \bold{No}, and \code{NULL}
+ for \bold{Cancel} actions.
-\seealso{
- \code{\link{system}}, \code{\link{select.list}}
+ \code{rk.select.list} returns the value of
+ \code{\link{select.list}}.
}
+\description{
+ Multi-purpose pop-up message boxes and selection list
+ using native KDE GUI elements. The message boxes can be
+ used either to show some information or ask some
+ question. The selection list can be used to get a vector
+ of selected items.
+}
+\details{
+ For \code{rk.show.question}, the R interpreter always
+ waits for the user's choice.
+
+ \code{rk.select.list} replaces \code{utils::select.list}
+ for the running session acting as a drop-in replacement
+ for \code{tk_select.list}. Use
+ \code{.rk.backups$select.list} for the original
+ \code{utils::select.list} function (see Examples).
+}
\examples{
require (rkward)
## Message boxes
-if (rk.show.question ("Question:\nDo you want to know about RKWard?",
+if (rk.show.question ("Question:\\nDo you want to know about RKWard?",
button.yes = "Yes, I do!", button.no = "No, I don't care!", button.cancel = "")) {
- rk.show.message ("Message:\nRKWard is a KDE GUI for R.", "RKWard Info")
+ rk.show.message ("Message:\\nRKWard is a KDE GUI for R.", "RKWard Info")
} else {
rk.show.message ("You must be joking!", "RKWard Info", wait = FALSE) ## Run asynchronously
}
## Selection lists:
-rk.select.list (LETTERS, preselect = c("A", "E", "I", "O", "U"),
+rk.select.list (LETTERS, preselect = c("A", "E", "I", "O", "U"),
multiple = TRUE, title = "vowels")
-.rk.backups$select.list (LETTERS, preselect = c("A", "E", "I", "O", "U"),
+.rk.backups$select.list (LETTERS, preselect = c("A", "E", "I", "O", "U"),
multiple = TRUE, title = "vowels")
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \code{\link{system}}, \code{\link{select.list}}
+}
+\keyword{utilities}
-\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,41 +1,48 @@
\name{rk.sync}
\alias{rk.sync}
\alias{rk.sync.global}
-
\title{Sync R object(s)}
+\usage{
+ rk.sync(x)
-\usage{
-rk.sync(x)
-rk.sync.global()
+ rk.sync.global()
}
-
\arguments{
-\item{x}{any R object to sync}
+ \item{x}{any R object to sync}
}
-
-\details{
-RKWard keeps an internal representation of objects in the R workspace. For objects in the \code{.GlobalEnv}, this representation is updated after each top-level statement. For the rare cases where this is not enough, \code{rk.sync} can be used to update the representation of a single object, \code{x}, while \code{rk.sync.global} scans the \code{.GlobalEnv} for new and removed objects, and updates as appropriate.
-
-These functions are rarely needed outside automated testing. However, rk.sync() can be useful, if an object outside the \code{.GlobalEnv} has changed, since this will not be detected automatically. Also, by default RKWard does not recurse into environments when updating its representation of objects. rk.sync() can be used, here, to inspect the objects inside environments (see examples).
-}
-
\value{
-\code{NULL}, invisibly.
+ \code{NULL}, invisibly.
}
-
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
-\section{Warning}{
-A typical user should not need to use these.
+\description{
+ RKWard keeps an internal representation of objects in the
+ R workspace. For objects in the \code{.GlobalEnv}, this
+ representation is updated after each top-level statement.
+ For the rare cases where this is not enough,
+ \code{rk.sync} can be used to update the representation
+ of a single object, \code{x}, while \code{rk.sync.global}
+ scans the \code{.GlobalEnv} for new and removed objects,
+ and updates as appropriate.
}
-
-\seealso{
-\url{rkward://page/rkward_workspace_browser}
+\details{
+ These functions are rarely needed outside automated
+ testing. However, rk.sync() can be useful, if an object
+ outside the \code{.GlobalEnv} has changed, since this
+ will not be detected automatically. Also, by default
+ RKWard does not recurse into environments when updating
+ its representation of objects. rk.sync() can be used,
+ here, to inspect the objects inside environments (see
+ examples).
}
-
\examples{
rk.sync (rkward::rk.record.plot)
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \url{rkward://page/rkward_workspace_browser}
+}
+\keyword{misc}
+\keyword{utilities}
-\keyword{utilities}
-\keyword{misc}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -1,46 +1,61 @@
-\name{RKWard_workplace}
+\name{rk.save.workplace}
+\alias{rk.restore.workplace}
\alias{rk.save.workplace}
-\alias{rk.restore.workplace}
-
\title{Save or restore RKWard workplace}
+\usage{
+ rk.save.workplace(file = NULL, description = NULL)
-\description{
+ rk.restore.workplace(file = NULL, close.windows = TRUE)
}
-
-\usage{
-rk.save.workplace(file=NULL, description=NULL)
-rk.restore.workplace(file=NULL, close.windows=TRUE)
-}
-
\arguments{
-\item{file}{a character string giving the url of the file to save to, or NULL for automatic selection of a suitable file (see Details).}
-\item{description}{For internal use, only. A character string describing the workplace status to save. Generally, you should leave this as the default value (\code{NULL}).}
-\item{close.windows}{a logical; whether current windows should be closed before restoring.}
-}
+ \item{file}{a character string giving the url of the file
+ to save to, or NULL for automatic selection of a suitable
+ file (see Details).}
-\details{
-\code{rk.save.workplace} can be used to save a representation of the RKWard workplace (i.e. which scripts, data edtiors and other windows are shown) to a file. \code{rk.restore.workplace} restores an RKWard workplace as saved by \code{rk.save.workplace}.
+ \item{description}{For internal use, only. A character
+ string describing the workplace status to save.
+ Generally, you should leave this as the default value
+ (\code{NULL}).}
-If the \code{file} parameter is omitted (or \code{NULL}), a suitable filename is selected automatically. If a workspace has been loaded, this is the URL of the workspace with an appended \code{.rkworkplace}. Otherwise a filename in the RKWard directory, as generated by \link{rk.get.tempfile.name}.
-
-NOTE: Not all types of windows can be saved and restored. Esp. graphics device windows will not be restored (but WILL be closed by \code{rk.restore.workplace()}, if \code{close.windows} is TRUE).
+ \item{close.windows}{a logical; whether current windows
+ should be closed before restoring.}
}
-
\value{
-Both functions return \code{NULL}.
+ Both functions return \code{NULL}.
}
+\description{
+ \code{rk.save.workplace} can be used to save a
+ representation of the RKWard workplace (i.e. which
+ scripts, data edtiors and other windows are shown) to a
+ file. \code{rk.restore.workplace} restores an RKWard
+ workplace as saved by \code{rk.save.workplace}.
+}
+\details{
+ If the \code{file} parameter is omitted (or \code{NULL}),
+ a suitable filename is selected automatically. If a
+ workspace has been loaded, this is the URL of the
+ workspace with an appended \code{.rkworkplace}. Otherwise
+ a filename in the RKWard directory, as generated by
+ \link{rk.get.tempfile.name}.
-\seealso{
-\url{rkward://page/rkward_for_r_users}, \link{rk.get.workspace.url}
+ NOTE: Not all types of windows can be saved and restored.
+ Esp. graphics device windows will not be restored (but
+ WILL be closed by \code{rk.restore.workplace()}, if
+ \code{close.windows} is TRUE).
}
-
-\author{Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}}
-
\examples{
## Not run
rk.save.workplace ()
rk.restore.workplace ()
## End not run
}
+\author{
+ Thomas Friedrichsmeier
+ \email{rkward-devel at lists.sourceforge.net}
+}
+\seealso{
+ \url{rkward://page/rkward_for_r_users},
+ \link{rk.get.workspace.url}
+}
+\keyword{utilities}
-\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd 2012-09-29 15:10:01 UTC (rev 4326)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd 2012-09-29 15:11:12 UTC (rev 4327)
@@ -8,8 +8,8 @@
}
\details{
\tabular{ll}{ Package: \tab rkward\cr Type: \tab
- Package\cr Version: \tab 0.5.8\cr Date: \tab
- 2012-03-20\cr Depends: \tab R (>= 2.9.0),methods\cr
+ Package\cr Version: \tab 0.6.0\cr Date: \tab
+ 2012-09-29\cr Depends: \tab R (>= 2.9.0),methods\cr
Encoding: \tab UTF-8\cr License: \tab GPL (>= 2)\cr
LazyLoad: \tab yes\cr URL: \tab
http://rkward.sourceforge.net\cr }
@@ -22,7 +22,8 @@
\author{
Thomas Friedrichsmeier
\email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, with
- contributions from the RKWard Team
+ contributions from RKWard-devel mailing list
+ \email{rkward-devel at lists.sourceforge.net}
}
\keyword{package}
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list