[rkward-cvs] SF.net SVN: rkward-code:[4854] trunk/rkward/rkward/rbackend/rpackages/ rkward
tfry at users.sf.net
tfry at users.sf.net
Mon Sep 29 11:29:31 UTC 2014
Revision: 4854
http://sourceforge.net/p/rkward/code/4854
Author: tfry
Date: 2014-09-29 11:29:30 +0000 (Mon, 29 Sep 2014)
Log Message:
-----------
Update roxygen-generated docs
Modified Paths:
--------------
trunk/rkward/rkward/rbackend/rpackages/rkward/DESCRIPTION
trunk/rkward/rkward/rbackend/rpackages/rkward/NAMESPACE
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
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.embed.device.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.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.old.packages.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.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.screen.device.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.without.plot.history.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/DESCRIPTION
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/DESCRIPTION 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/DESCRIPTION 2014-09-29 11:29:30 UTC (rev 4854)
@@ -22,15 +22,15 @@
Date: 2012-09-29
Collate:
'base_overrides.R'
+ 'internal.R'
'internal_debugger.R'
- 'internal.R'
'internal_graphics.R'
'internal_help.R'
'public_graphics.R'
+ 'rk.KDE_GUI-functions.R'
'rk.demo.R'
'rk.edit-functions.R'
'rk.filename-functions.R'
- 'rk.KDE_GUI-functions.R'
'rk.label-functions.R'
'rk.plugin-functions.R'
'rk.print-functions.R'
@@ -38,6 +38,6 @@
'rk.sessionInfo.R'
'rk.sync-functions.R'
'rk.utility-functions.R'
+ 'rk.workspace-functions.R'
'rkward-package.R'
- 'rk.workspace-functions.R'
'ver.R'
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/NAMESPACE
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/NAMESPACE 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/NAMESPACE 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,83 +1,99 @@
-export(makeActiveBinding)
+# Generated by roxygen2 (4.0.2): do not edit by hand
+
export(.onAttach)
-export(q)
-export(quartz)
-export(quit)
-export(require)
-export(RK)
export(.rk.app.version)
export(.rk.backups)
export(.rk.cached.available.packages)
-export(rk.call.plugin)
export(.rk.callstack.info)
export(.rk.cat.output)
-export(rk.clear.plot.history)
export(.rk.data.frame.delete.row)
export(.rk.data.frame.insert.column)
export(.rk.data.frame.insert.row)
-export(rk.demo)
-export(rk.describe.alternative)
export(.rk.do.call)
export(.rk.do.error)
export(.rk.do.plain.call)
+export(.rk.find.package.pluginmaps)
+export(.rk.fix.assignments)
+export(.rk.fix.assignments.graphics)
+export(.rk.get.environment.children)
+export(.rk.get.installed.packages)
+export(.rk.get.meta)
+export(.rk.get.package.intallation.state)
+export(.rk.get.search.results)
+export(.rk.get.slots)
+export(.rk.get.structure)
+export(.rk.get.structure.global)
+export(.rk.get.vector.data)
+export(.rk.getHelp)
+export(.rk.getHelpBaseUrl)
+export(.rk.inside.rkward.session)
+export(.rk.killPreviewDevice)
+export(.rk.make.hr)
+export(.rk.make.short.name)
+export(.rk.make.watch.f)
+export(.rk.rerun.plugin.link)
+export(.rk.set.invalid.fields)
+export(.rk.set.levels)
+export(.rk.set.meta)
+export(.rk.set.reply)
+export(.rk.set.vector.mode)
+export(.rk.startPreviewDevice)
+export(.rk.try.get.namespace)
+export(.rk.unwatch.symbol)
+export(.rk.variables)
+export(.rk.watch.globalenv)
+export(.rk.watch.symbol)
+export(.rk.watched.symbols)
+export(RK)
+export(Sys.setlocale)
+export(X11)
+export(makeActiveBinding)
+export(q)
+export(quartz)
+export(quit)
+export(require)
+export(rk.call.plugin)
+export(rk.clear.plot.history)
+export(rk.demo)
+export(rk.describe.alternative)
export(rk.duplicate.device)
export(rk.edit)
export(rk.edit.files)
export(rk.embed.device)
-export(.rk.find.package.pluginmaps)
export(rk.first.plot)
-export(.rk.fix.assignments)
-export(.rk.fix.assignments.graphics)
export(rk.flush.output)
export(rk.force.append.plot)
export(rk.get.description)
-export(.rk.get.environment.children)
-export(.rk.getHelp)
-export(.rk.getHelpBaseUrl)
-export(.rk.get.installed.packages)
export(rk.get.label)
-export(.rk.get.meta)
export(rk.get.output.html.file)
-export(.rk.get.package.intallation.state)
-export(.rk.get.search.results)
export(rk.get.short.name)
-export(.rk.get.slots)
-export(.rk.get.structure)
-export(.rk.get.structure.global)
export(rk.get.tempfile.name)
-export(.rk.get.vector.data)
export(rk.get.workspace.url)
export(rk.goto.plot)
export(rk.graph.off)
export(rk.graph.on)
export(rk.header)
-export(.rk.inside.rkward.session)
-export(.rk.killPreviewDevice)
export(rk.last.plot)
export(rk.list)
export(rk.list.labels)
export(rk.list.names)
export(rk.list.plugins)
export(rk.load.pluginmaps)
-export(.rk.make.hr)
export(rk.make.repos.string)
-export(.rk.make.short.name)
-export(.rk.make.watch.f)
export(rk.next.plot)
export(rk.old.packages)
export(rk.plot.history.summary)
export(rk.previous.plot)
export(rk.print)
export(rk.print.code)
+export(rk.print.literal)
export(rk.printer.device)
-export(rk.print.literal)
export(rk.record.commands)
export(rk.record.plot)
export(rk.relative.src.line)
export(rk.removethis.plot)
export(rk.rename.in.container)
export(rk.replace.function)
-export(.rk.rerun.plugin.link)
export(rk.restore.workplace)
export(rk.results)
export(rk.save.workplace)
@@ -85,33 +101,19 @@
export(rk.select.CRAN.mirror)
export(rk.select.list)
export(rk.sessionInfo)
-export(.rk.set.invalid.fields)
export(rk.set.label)
-export(.rk.set.levels)
-export(.rk.set.meta)
export(rk.set.output.html.file)
-export(.rk.set.reply)
-export(.rk.set.vector.mode)
export(rk.show.files)
export(rk.show.html)
export(rk.show.message)
export(rk.show.plot.info)
export(rk.show.question)
-export(.rk.startPreviewDevice)
export(rk.sync)
export(rk.sync.global)
export(rk.toggle.plot.history)
-export(.rk.try.get.namespace)
-export(.rk.unwatch.symbol)
-export(.rk.variables)
export(rk.verify.plot.hist.limits)
-export(.rk.watched.symbols)
-export(.rk.watch.globalenv)
-export(.rk.watch.symbol)
export(rk.without.plot.history)
export(setwd)
-export(Sys.setlocale)
+export(win.graph)
export(windows)
-export(win.graph)
export(x11)
-export(X11)
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R 2014-09-29 11:29:30 UTC (rev 4854)
@@ -28,7 +28,7 @@
#' @param x a string, giving the filename of the of the output file
#' @param additional.header.contents NULL or an additional string to add to the HTML header section.
#' This could be scripts or additional CSS definitions, for example. Note that
-#' @em nothing will be added to the header, if the file already exists.
+#' \emph{nothing} will be added to the header, if the file already exists.
#' @param flush.images. If true, any images used in the output file will be deleted as well.
#' @param ask Logical: Whether to ask before flushing the output file.
#' @return \code{rk.get.tempfile.name}, \code{rk.get.output.html.file}, and
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{RK}
\alias{RK}
\title{Plot graphics to RKWard native device}
@@ -2,37 +3,26 @@
\usage{
- RK(width = getOption("rk.screendevice.width"),
- height = getOption("rk.screendevice.height"),
- pointsize = 12, family = NULL, bg = "white",
- title = "", antialias = TRUE)
+RK(width = getOption("rk.screendevice.width"),
+ height = getOption("rk.screendevice.height"), pointsize = 12,
+ family = NULL, bg = "white", title = "", antialias = TRUE)
}
\arguments{
- \item{width}{Width of the device in inches. The default
- is to use the heigth configured in Settings -> Configure
- RKWard -> Onscreen Graphics.}
+\item{width}{Width of the device in inches. The default is to use the heigth configured in Settings -> Configure RKWard -> Onscreen Graphics.}
- \item{height}{Height of the device in inchesgraphics in
- pixels. The default is to use the heigth configured in
- Settings -> Configure RKWard -> Onscreen Graphics.}
+\item{height}{Height of the device in inchesgraphics in pixels. The default is to use the heigth configured in Settings -> Configure RKWard -> Onscreen Graphics.}
- \item{pointsize}{Default pointsize}
+\item{pointsize}{Default pointsize}
- \item{family}{Default font family. This can be a
- character vector of length 1 or 2. The second value is
- used for plotting symbols. Effectively the default is
- c("Helvetica", "Symbol"). A wide variety of sepcification
- is supported, including the device independent fonts
- names "sans", "serif", and "mono"}
+\item{family}{Default font family. This can be a character vector of length 1 or 2. The second value is used for
+plotting symbols. Effectively the default is c("Helvetica", "Symbol"). A wide variety of sepcification is supported,
+including the device independent fonts names "sans", "serif", and "mono"}
- \item{bg}{Background color.}
+\item{bg}{Background color.}
- \item{title}{Window title.}
+\item{title}{Window title.}
- \item{antialias}{Antialiasing. Can be turned off for
- somewhat faster drawing.}
+\item{antialias}{Antialiasing. Can be turned off for somewhat faster drawing.}
}
\description{
- \code{RK()} creates an R on-screen device that will be
- rendered in the RKWard frontend. The default settings for
- \code{width}, and \code{height} can be modified from
- Settings -> Configure RKWard -> Onscreen Graphics.
+\code{RK()} creates an R on-screen device that will be rendered in the RKWard frontend.
+The default settings for \code{width}, and \code{height} can be modified from Settings -> Configure RKWard -> Onscreen Graphics.
}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.list.plugins}
\alias{rk.call.plugin}
\alias{rk.list.plugins}
@@ -3,67 +4,56 @@
\title{Call or list built-in RKWard plugin(s)}
\usage{
- rk.list.plugins()
+rk.list.plugins()
- rk.call.plugin(plugin, ...,
- submit.mode = c("manual", "auto", "submit"))
+rk.call.plugin(plugin, ..., submit.mode = c("manual", "auto", "submit"))
}
\arguments{
- \item{plugin}{character string, giving the name of the
- plugin to call. See Details.}
+\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{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{\dots}{arguments passed to the \code{plugin}}
}
\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.
+\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.
+\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.
+\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.
+\code{rk.list.plugins} returns the list of the names of all currently
+registered plugins.
}
\examples{
@@ -84,12 +74,10 @@
})
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{rk.results}},
- \url{rkward://page/rkward_output}
+\code{\link{rk.results}}, \url{rkward://page/rkward_output}
}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.demo.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.demo}
\alias{rk.demo}
\title{Opens an R demo script for editing}
@@ -2,21 +3,19 @@
\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{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.}
+\item{lib.loc}{Library locations.}
}
\value{
- Return \code{NULL}, unconditionally.
+Return \code{NULL}, unconditionally.
}
\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.
+\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.
}
@@ -27,11 +26,10 @@
rk.demo("graphics")
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{rk.edit.files}}, \code{\link{rk.show.files}},
+\code{\link{rk.edit.files}}, \code{\link{rk.show.files}},
\code{\link{demo}}
}
\keyword{IO}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.edit}
\alias{rk.edit}
\alias{rk.edit.files}
@@ -5,55 +6,50 @@
\alias{rk.show.html}
\title{Edit / show an object / file}
\usage{
- rk.edit(x)
+rk.edit(x)
- rk.edit.files(file = file, title = file, name = NULL,
- prompt = TRUE)
+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.files(file = file, header = file, title = NULL,
+ delete.file = FALSE, prompt = TRUE, delete = delete.file)
- rk.show.html(url)
+rk.show.html(url)
}
\arguments{
- \item{x}{an object to edit.}
+\item{x}{an object to edit.}
- \item{file}{character vector, filenames to show or 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{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{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.}
- \item{delete}{a logical (not NA), when \code{TRUE} the
- shown file(s) are deleted after closing.}
+\item{wtitle}{character vector, of length 1. This will be used as the window
+title.}
}
\value{
- All functions described on this page return \code{NULL},
+All functions described on this page return \code{NULL},
unconditionally.
}
\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.
+\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.
+\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
@@ -61,11 +57,10 @@
rk.edit(x)
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{edit}}, \code{\link{file.edit}},
+\code{\link{edit}}, \code{\link{file.edit}},
\code{\link{file.show}}, \code{\link{browseURL}}
}
\keyword{IO}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.embed.device}
\alias{rk.embed.device}
\title{Embed non-RKWard device windows}
@@ -2,31 +3,21 @@
\usage{
- rk.embed.device(expr)
+rk.embed.device(expr)
}
\arguments{
- \item{expr}{Expression to evaluate.}
+\item{expr}{Expression to evaluate.}
}
\description{
- \code{rk.embed.device} evaluates the given expression,
- and if this has created a window on the screen, tries to
- embed it as an RKWard window.
+\code{rk.embed.device} evaluates the given expression, and if this has created a window on the screen, tries to embed it as an RKWard window.
}
\details{
- Theoretically, \code{expr} can be any valid R expression.
- However typically this should be calls to X11(),
- Windows(), or, perhaps dev.copy(). Importantly, the
- expression should create exactly one new window for
- \code{rk.embed.device()} to work. Keep in mind, that this
- is not always the case for \code{plot(...)} and similar
- commands, which will re-use an existing plot window, if
- available.
+Theoretically, \code{expr} can be any valid R expression. However typically this should be calls to X11(), Windows(), or, perhaps dev.copy().
+ Importantly, the expression should create exactly one new window for \code{rk.embed.device()} to work. Keep in mind, that this is not
+ always the case for \code{plot(...)} and similar commands, which will re-use an existing plot window, if available.
}
\note{
- \code{rk.embed.device()} will not work on all platforms
- (most importantly, not in most MacOSX binaries). Further,
- note that a captured \code{X11()} or \code{Windows}
- device may look similar to an \code{RK()} device, but is
- actually a very different thing.
+\code{rk.embed.device()} will not work on all platforms (most importantly, not in most MacOSX binaries). Further, note that a captured
+ \code{X11()} or \code{Windows} device may look similar to an \code{RK()} device, but is actually a very different thing.
}
\seealso{
- \link{RK}
+\link{RK}
}
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 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.get.tempfile.name}
\alias{rk.flush.output}
\alias{rk.get.output.html.file}
@@ -6,71 +7,60 @@
\alias{rk.set.output.html.file}
\title{RKWard file names}
\usage{
- rk.get.tempfile.name(prefix = "image",
- extension = ".jpg")
+rk.get.tempfile.name(prefix = "image", extension = ".jpg")
- rk.get.workspace.url()
+rk.get.workspace.url()
- rk.get.output.html.file()
+rk.get.output.html.file()
- rk.set.output.html.file(x,
- additional.header.contents = getOption("rk.html.header.additions"))
+rk.set.output.html.file(x,
+ additional.header.contents = getOption("rk.html.header.additions"))
- rk.flush.output(x = rk.get.output.html.file(),
- flush.images = TRUE, ask = TRUE)
+rk.flush.output(x = rk.get.output.html.file(), flush.images = TRUE,
+ ask = TRUE)
}
\arguments{
- \item{prefix}{a string, used as a filename prefix when
- saving images to the output file}
+\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{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{x}{a string, giving the filename of the of the output file}
- \item{additional.header.contents}{NULL or an additional
- string to add to the HTML header section. This could be
- scripts or additional CSS definitions, for example. Note
- that}
+\item{additional.header.contents}{NULL or an additional string to add to the HTML header section.
+This could be scripts or additional CSS definitions, for example. Note that
+\emph{nothing} will be added to the header, if the file already exists.}
- \item{flush.images.}{If true, any images used in the
- output file will be deleted as well.}
+\item{ask}{Logical: Whether to ask before flushing the output file.}
- \item{ask}{Logical: Whether to ask before flushing the
- output file.}
+\item{flush.images.}{If true, any images used in the output file will be deleted as well.}
}
\value{
- \code{rk.get.tempfile.name},
- \code{rk.get.output.html.file}, and
+\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}.
- \code{rk.flush.output.html.file} will delete the current
- (or specified) html file, and re-initialize it.
+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}. \code{rk.flush.output.html.file} will delete
+the current (or specified) html file, and re-initialize it.
}
\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.
+\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.
+\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")
@@ -89,12 +79,11 @@
rk.set.output.html.file(outfile)
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \url{rkward://page/rkward_output}, \link{tempfile},
- \link{file}, \link{rk.print}
+\url{rkward://page/rkward_output}, \link{tempfile}, \link{file},
+ \link{rk.print}
}
\keyword{IO}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.graph.on}
\alias{rk.graph.off}
\alias{rk.graph.on}
@@ -3,47 +4,31 @@
\title{Plot graphics to HTML output file}
\usage{
- rk.graph.on(device.type = getOption("rk.graphics.type"),
- width = getOption("rk.graphics.width"),
- height = getOption("rk.graphics.height"), quality, ...)
+rk.graph.on(device.type = getOption("rk.graphics.type"),
+ width = getOption("rk.graphics.width"),
+ height = getOption("rk.graphics.height"), quality, ...)
- rk.graph.off()
+rk.graph.off()
}
\arguments{
- \item{device.type}{Type of device to create / graphics
- format to use. Currently, supported devices are "PNG",
- "SVG", or "JPG". The default is to use the format
- configured in Settings -> Configure RKWard -> Output.}
+\item{device.type}{Type of device to create / graphics format to use. Currently, supported devices are "PNG", "SVG", or "JPG".
+The default is to use the format configured in Settings -> Configure RKWard -> Output.}
- \item{width}{Width of graphics in pixels. The default is
- to use the width configured in Settings -> Configure
- RKWard -> Output.}
+\item{width}{Width of graphics in pixels. The default is to use the width configured in Settings -> Configure RKWard -> Output.}
- \item{height}{Height of graphics in pixels. The default
- is to use the heigth configured in Settings -> Configure
- RKWard -> Output.}
+\item{height}{Height of graphics in pixels. The default is to use the heigth configured in Settings -> Configure RKWard -> Output.}
- \item{quality}{For device.type "JPG", quality of the JPG
- file from 0 to 100. The default is to use the quality
- configured in Settings -> Configure RKWard -> Output.}
+\item{quality}{For device.type "JPG", quality of the JPG file from 0 to 100.
+The default is to use the quality configured in Settings -> Configure RKWard -> Output.}
- \item{...}{Further options will be passed to the graphics
- device used internally.
+\item{...}{Further options will be passed to the graphics device used internally.
- \bold{Warning}: It is advised to use \code{rk.graph.off}
- and \bold{not} \code{dev.off} to close the device opened
- by \code{rk.graph.on}. \code{dev.print(device =
- rk.graph.on)} is a \bold{wrong} usage for this "device,"
- and will result in errors.}
+\bold{Warning}: It is advised to use \code{rk.graph.off} and \bold{not} \code{dev.off} to close the device opened by
+\code{rk.graph.on}. \code{dev.print(device = rk.graph.on)} is a \bold{wrong} usage for this "device," and will result in errors.}
}
\description{
- \code{rk.graph.on()} creates an R device that will plot
- to the output html page in RKWard
- (\url{rkward://page/rkward_output}). The default settings
- for \code{device.type}, \code{width}, \code{height}, and
- \code{quality} can be modified from Settings -> Configure
- RKWard -> Output.
+\code{rk.graph.on()} creates an R device that will plot to the output html page in RKWard (\url{rkward://page/rkward_output}).
+The default settings for \code{device.type}, \code{width}, \code{height}, and \code{quality} can be modified from Settings -> Configure RKWard -> Output.
- \code{rk.graph.off()} closes the device that was opened
- by \code{rk.graph.on}.
+\code{rk.graph.off()} closes the device that was opened by \code{rk.graph.on}.
}
\examples{
@@ -65,13 +50,10 @@
#dev.print (device = rk.graph.on)
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \link{rk.results} \link{rk.print}
- \link{rk.get.output.html.file} \link{dev.off} \link{svg}
- \link{png} \link{jpg}
+\link{rk.results} \link{rk.print} \link{rk.get.output.html.file} \link{dev.off} \link{svg} \link{png} \link{jpg}
}
\keyword{devices}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.label.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,90 +1,77 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.get.label}
+\alias{.rk.make.short.name}
\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.get.label(x)
- rk.set.label(x, label, envir = parent.frame())
+rk.set.label(x, label, envir = parent.frame())
- rk.list.labels(x, fill = FALSE)
+rk.list.labels(x, fill = FALSE)
- rk.get.short.name(x)
+rk.get.short.name(x)
- .rk.make.short.name(x)
+.rk.make.short.name(x)
- rk.get.description(..., paste.sep = NULL,
- is.substitute = FALSE)
+rk.get.description(..., paste.sep = NULL, is.substitute = FALSE)
- rk.list(...)
+rk.list(...)
- rk.list.names(..., deparse.level = 2)
+rk.list.names(..., deparse.level = 2)
}
\arguments{
- \item{x}{any R object}
+\item{x}{any R object}
- \item{label}{a string, to set the label attribute of an
- object}
+\item{label}{a string, to set the label attribute of an object}
- \item{envir}{an environment, where the attribute is
- evaluated}
+\item{envir}{an environment, where the attribute is evaluated}
- \item{fill}{a logical or character. See Details.}
+\item{fill}{a logical or character. See Details.}
- \item{paste.sep}{a string, used as the \code{collapse}
- argument for paste}
+\item{paste.sep}{a string, used as the \code{collapse} argument for paste}
- \item{is.substitute}{a logical (not NA). See Details.}
+\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.
+\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.
+\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.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.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.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.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.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}}.
+\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))
@@ -98,8 +85,7 @@
names (rk.list (x$a, x$b)) # "x$a (First column)" "x$b"
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+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 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.load.pluginmaps}
\alias{rk.load.pluginmaps}
\title{(Re-)load the given pluginmap files into the RKWard GUI}
@@ -2,32 +3,25 @@
\usage{
- rk.load.pluginmaps(pluginmap.files = NULL,
- force.add = TRUE, force.reload = TRUE)
+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
- effect is to reload all active pluginmaps.}
+\item{pluginmap.files}{a character vector of file names to add. This may be left empty,
+if the only desired effect is to reload all active pluginmaps.}
- \item{force.add}{logical. Whether the pluginmap files
- should also be added, if they had been previously
- de-selected in the settings menu, and regardless of their
- priority setting. In scripted usage, this should
- generally be set to FALSE.}
+\item{force.add}{logical. Whether the pluginmap files should also be added, if they had
+been previously de-selected in the settings menu, and regardless of their
+priority setting. In scripted usage, this should generally be set to FALSE.}
- \item{force.reload}{logical. By default the active
- pluginmaps are reloaded, only if any new ones were added.
- If set to TRUE, pluginmaps are reloaded in any case. In
- scripted usage, this should generally be set to FALSE.
- NOTE: Since a reload always means reloading _all_ active
- pluginmaps, This may be slow, and should be used with
- care.
+\item{force.reload}{logical. By default the active pluginmaps are reloaded, only if any new ones
+ were added. If set to TRUE, pluginmaps are reloaded in any case. In
+ scripted usage, this should generally be set to FALSE. NOTE: Since
+ a reload always means reloading _all_ active pluginmaps, This may be
+ slow, and should be used with care.
- \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
- affected by this function.}
+\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 affected by this function.}
}
\description{
- (Re-)load the given pluginmap files into the RKWard GUI
+(Re-)load the given pluginmap files into the RKWard GUI
}
@@ -42,13 +36,12 @@
## END NOT RUN
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{rk.call.plugin}},
+\code{\link{rk.call.plugin}},
- \code{\link{rkwarddev::rk.plugin.skeleton}}
+\code{\link{rkwarddev::rk.plugin.skeleton}}
}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.rename.in.container}
\alias{rk.make.repos.string}
\alias{rk.misc}
@@ -5,48 +6,43 @@
\alias{rk.select.CRAN.mirror}
\title{Miscellaneous utility functions}
\usage{
- rk.rename.in.container(x, old_name, new_name,
- envir = parent.frame())
+rk.rename.in.container(x, old_name, new_name, envir = parent.frame())
- rk.make.repos.string()
+rk.make.repos.string()
- rk.select.CRAN.mirror()
+rk.select.CRAN.mirror()
}
\arguments{
- \item{x}{a data.frame or list.}
+\item{x}{a data.frame or list.}
- \item{old_name}{a string, the name of the column or
- element to be renamed.}
+\item{old_name}{a string, the name of the column or element to be renamed.}
- \item{new_name}{a string, the new name.}
+\item{new_name}{a string, the new name.}
- \item{envir}{an environment where \code{x} is available.}
+\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.
+\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.
+\code{rk.make.repos.string} just creates a R statement for \code{repos}. A
+typical user should not need to use this function.
- \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.
+\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
@@ -56,8 +52,7 @@
str (ir)
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\keyword{attribute}
\keyword{misc}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.old.packages}
\alias{rk.old.packages}
\title{Slightly smarter variant of old.packages()}
@@ -2,24 +3,17 @@
\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"))
+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
+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.
+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.
}
@@ -30,8 +24,7 @@
rk.old.packages()
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\keyword{attribute}
\keyword{misc}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.printer.device.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.printer.device}
\alias{rk.printer.device}
\title{Device for printing using the KDE print dialog}
@@ -2,21 +3,18 @@
\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.
+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).
+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.
}
@@ -28,11 +26,10 @@
dev.print (rk.printer.device)
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{postscript}}, \code{\link{dev.print}},
+\code{\link{postscript}}, \code{\link{dev.print}},
\code{\link{rk.graph.on}}
}
\keyword{device}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.record.commands}
\alias{rk.record.commands}
\title{Start recording commands that are submitted from RKWard to R}
@@ -2,17 +3,13 @@
\usage{
- rk.record.commands(filename, include.all = FALSE)
+rk.record.commands(filename, include.all = FALSE)
}
\arguments{
- \item{filename}{filename to write to (file will be
- truncated!).}
+\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?}
+\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.
+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 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.replace.function.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.replace.function}
\alias{rk.replace.function}
\title{Replace a function inside its package environment / namespace}
@@ -2,41 +3,36 @@
\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{functionname}{name of the function to be replaced (character).}
- \item{environment}{package environment or namespace,
- where replacment should be done.}
+\item{environment}{package environment or namespace, where replacment should
+be done.}
- \item{replacement}{the replacement. This should be a
- function.}
+\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{copy.formals}{logical; whether to copy the \code{\link{formals}} from
+the original function.}
}
\value{
- Returns \code{NULL}, invisibly, unconditionally.
+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.
+\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.
+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.
- \bold{WARNING}: This function can be used to alter - and
- disrupt - internal functions in arbitrary ways. You
- better know what you are doing.
+\bold{WARNING}: This function can be used to alter - and disrupt - internal
+functions in arbitrary ways. You better know what you are doing.
- \bold{WARNING}: Does not work well on generics!
+\bold{WARNING}: Does not work well on generics!
}
@@ -52,11 +48,10 @@
## End not run
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{assignInNamespace}}, \code{\link{debug}}
+\code{\link{assignInNamespace}}, \code{\link{debug}}
}
\keyword{IO}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.results.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.print}
\alias{rk.describe.alternative}
\alias{rk.header}
@@ -7,90 +8,76 @@
\alias{rk.results}
\title{Print objects and results to output}
\usage{
- rk.print(x, ...)
+rk.print(x, ...)
- rk.print.code(code)
+rk.print.code(code)
- rk.header(title, parameters = list(), level = 1,
- toc = NULL)
+rk.header(title, parameters = list(), level = 1, toc = NULL)
- rk.results(x, titles = NULL, print.rownames)
+rk.results(x, titles = NULL, print.rownames)
- rk.print.literal(x)
+rk.print.literal(x)
- rk.describe.alternative(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{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{code}{a character vector (single string) of R code}
- \item{title}{a string, used as a header for the html
- output}
+\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{parameters}{a list, preferably named, giving a list
- of "parameters" to be printed to the output}
+\item{level}{an integer, header level. For example, \code{level=2} creates
+the header with \code{<h2></h>} tag.}
- \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.}
+\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.}
- \item{titles}{a character vector, giving the column
- headers for a html table.}
+\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{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.
+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}}.
+\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}}.
- \code{rk.print.literal} prints/exports the given object
- using a \code{paste(x, collapse="\n")} construct to the
- output (html) file.
+\code{rk.print.literal} prints/exports the given object using a
+\code{paste(x, collapse="\n")} construct to the output (html) file.
- \code{rk.print.code} applies syntax highlighting to the
- given code string, and writes it to the output (html)
- file.
+\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.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.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.
+\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)
@@ -126,14 +113,11 @@
})
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+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}},
+\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}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.screen.device}
\alias{rk.screen.device}
\title{DEPRECATED: \code{rk.screen.device} is obsolete. It simply calls \code{dev.new()} in this version of RKWard.}
@@ -2,11 +3,9 @@
\usage{
- rk.screen.device(...)
+rk.screen.device(...)
}
\description{
- Depending on your use case, you should use
- \code{dev.new()}, \code{RK()} or
- \code{rk.embed.device()}, instead.
+Depending on your use case, you should use \code{dev.new()}, \code{RK()} or \code{rk.embed.device()}, instead.
}
\seealso{
- \link{dev.new}, \link{RK}, \link{rk.embed.device}
+\link{dev.new}, \link{RK}, \link{rk.embed.device}
}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.sessionInfo}
\alias{rk.sessionInfo}
\title{Print information on the RKWard session}
@@ -2,18 +3,16 @@
\usage{
- rk.sessionInfo()
+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.
+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.
+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{
- 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()}.
}
@@ -23,11 +22,10 @@
rk.sessionInfo()
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{sessionInfo}}
+\code{\link{sessionInfo}}
}
\keyword{misc}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.show.message}
\alias{rk.select.list}
\alias{rk.show.message}
@@ -4,74 +5,63 @@
\alias{rk.show.question}
\title{Message boxes and selection list using native KDE GUI}
\usage{
- rk.show.message(message, caption = "Information",
- wait = TRUE)
+rk.show.message(message, caption = "Information", wait = TRUE)
- rk.show.question(message, caption = "Question",
- button.yes = "yes", button.no = "no",
- button.cancel = "cancel")
+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)
+rk.select.list(list, preselect = NULL, multiple = FALSE, title = NULL)
}
\arguments{
- \item{message}{a string for the content of the message
- box.}
+\item{message}{a string for the content of the message box.}
- \item{caption}{a string for title 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{wait}{a logical (not NA) indicating whether the R interpreter should
+wait for the user's action, or run it asynchronously.}
- \item{button.no}{a string used for the text label of the
- \bold{No} button, similar to \code{button.yes}.}
+\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.canel}{a string used for the text label of
- the \bold{Cancel} button, similar to \code{button.yes}.}
+\item{button.no}{a string used for the text label of the \bold{No} 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{list}{a vector, coerced into a character vector.}
+\item{multiple}{a logical (not NA), when \code{TRUE} multiple selection
+selection is allowed.}
- \item{preselct}{a vector, coerced into a character
- vector, items to be preselected.}
+\item{title}{a string, for the window title of the displayed list}
- \item{multiple}{a logical (not NA), when \code{TRUE}
- multiple selection selection is allowed.}
+\item{button.canel}{a string used for the text label of the \bold{Cancel}
+button, similar to \code{button.yes}.}
- \item{title}{a string, for the window title of the
- displayed list}
+\item{preselct}{a vector, coerced into a character vector, items to be
+preselected.}
}
\value{
- \code{rk.show.message} always returns \code{TRUE},
- invisibly.
+\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.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.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.
+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.
+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).
+\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)
@@ -91,11 +81,10 @@
multiple = TRUE, title = "vowels")
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \code{\link{system}}, \code{\link{select.list}}
+\code{\link{system}}, \code{\link{select.list}}
}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.sync}
\alias{rk.sync}
\alias{rk.sync.global}
@@ -3,43 +4,38 @@
\title{Sync R object(s)}
\usage{
- rk.sync(x)
+rk.sync(x)
- rk.sync.global()
+rk.sync.global()
}
\arguments{
- \item{x}{any R object to sync}
+\item{x}{any R object to sync}
}
\value{
- \code{NULL}, invisibly.
+\code{NULL}, invisibly.
}
\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.
+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.
}
\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).
+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}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \url{rkward://page/rkward_workspace_browser}
+\url{rkward://page/rkward_workspace_browser}
}
\keyword{misc}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.without.plot.history}
\alias{rk.without.plot.history}
\title{Run a (plotting) action, without recording anything in the plot history.
@@ -3,10 +4,9 @@
Internally, the plot history option is turned off for the duration of the action.}
\usage{
- rk.without.plot.history(expr)
+rk.without.plot.history(expr)
}
\description{
- Run a (plotting) action, without recording anything in
- the plot history. Internally, the plot history option is
- turned off for the duration of the action.
+Run a (plotting) action, without recording anything in the plot history.
+Internally, the plot history option is turned off for the duration of the action.
}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\name{rk.save.workplace}
\alias{rk.restore.workplace}
\alias{rk.save.workplace}
@@ -3,43 +4,38 @@
\title{Save or restore RKWard workplace}
\usage{
- rk.save.workplace(file = NULL, description = NULL)
+rk.save.workplace(file = NULL, description = NULL)
- rk.restore.workplace(file = NULL, close.windows = TRUE)
+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{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{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{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}.
+\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}.
+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).
+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).
}
\examples{
@@ -50,12 +46,10 @@
## End not run
}
\author{
- Thomas Friedrichsmeier
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{rkward-devel at lists.sourceforge.net}
}
\seealso{
- \url{rkward://page/rkward_for_r_users},
- \link{rk.get.workspace.url}
+\url{rkward://page/rkward_for_r_users}, \link{rk.get.workspace.url}
}
\keyword{utilities}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd 2014-09-29 11:18:32 UTC (rev 4853)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd 2014-09-29 11:29:30 UTC (rev 4854)
@@ -1,3 +1,4 @@
+% Generated by roxygen2 (4.0.2): do not edit by hand
\docType{package}
\name{rkward-package}
\alias{rkward}
@@ -4,26 +5,26 @@
\alias{rkward-package}
\title{Provides functions related to the RKWard GUI.}
\description{
- Provides functions related to the RKWard GUI.
+Provides functions related to the RKWard GUI.
}
\details{
- \tabular{ll}{ Package: \tab rkward\cr Type: \tab
- 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 }
+\tabular{ll}{
+Package: \tab rkward\cr
+Type: \tab 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
+}
- This package contains functions which are useful in
- combination with the RKWard GUI. Many of these functions
- only needed for the internal communication between RKWard
- and R, but some are also useful in user scripts.
+This package contains functions which are useful in combination with the RKWard GUI. Many of these
+functions only needed for the internal communication between RKWard and R, but some are also useful in user scripts.
}
\author{
- Thomas Friedrichsmeier
- \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, with
- contributions from RKWard-devel mailing list
- \email{rkward-devel at lists.sourceforge.net}
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, with contributions from RKWard-devel mailing list \email{rkward-devel at lists.sourceforge.net}
}
\keyword{package}
More information about the rkward-tracker
mailing list