[education/rkward] rkward/rbackend/rpackages/rkward: further code cleaning in the rkward R package
m.eik michalke
null at kde.org
Wed Sep 20 11:59:26 BST 2023
Git commit 4e647d72ce2b781326b14c0a1a3fb4fb484cf0cc by m.eik michalke.
Committed on 20/09/2023 at 12:55.
Pushed by meikm into branch 'master'.
further code cleaning in the rkward R package
- replaced the static man/rk.record.plot.Rd with roxygenized content from R/public_graphics.R
- added missing documentation on various arguments
- fixed some typos
- re-enabled roxygenized documentation for device overrides (X11() etc.) which doesn't seem to cause problems any longer
M +1 -1 rkward/rbackend/rpackages/rkward/NAMESPACE
M +10 -2 rkward/rbackend/rpackages/rkward/R/internal_debugger.R
M +1 -0 rkward/rbackend/rpackages/rkward/R/internal_graphics.R
M +164 -28 rkward/rbackend/rpackages/rkward/R/public_graphics.R
M +2 -1 rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
M +2 -0 rkward/rbackend/rpackages/rkward/R/rk.completion-functions.R
M +1 -1 rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
M +2 -0 rkward/rbackend/rpackages/rkward/R/rk.label-functions.R
M +3 -1 rkward/rbackend/rpackages/rkward/R/rk.output.R
M +5 -2 rkward/rbackend/rpackages/rkward/R/rk.print-functions.R
M +2 -1 rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R
A +166 -0 rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
M +4 -0 rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
M +2 -0 rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
M +5 -0 rkward/rbackend/rpackages/rkward/man/rk.get.completions.Rd
M +2 -2 rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
M +4 -0 rkward/rbackend/rpackages/rkward/man/rk.label.Rd
M +43 -1 rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
M +87 -56 rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
A +25 -0 rkward/rbackend/rpackages/rkward/man/rk.relative.src.line.Rd
M +2 -0 rkward/rbackend/rpackages/rkward/man/rk.results.Rd
M +3 -0 rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
M +5 -3 rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
D +0 -13 rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd
https://invent.kde.org/education/rkward/-/commit/4e647d72ce2b781326b14c0a1a3fb4fb484cf0cc
diff --git a/rkward/rbackend/rpackages/rkward/NAMESPACE b/rkward/rbackend/rpackages/rkward/NAMESPACE
index 57f00c0df..f8ff57bbc 100644
--- a/rkward/rbackend/rpackages/rkward/NAMESPACE
+++ b/rkward/rbackend/rpackages/rkward/NAMESPACE
@@ -37,6 +37,7 @@ export(.rk.try.get.namespace)
export(.rk.variables)
export(.rk.with.window.hints)
export(RK)
+export(RK.Output)
export(Sys.setlocale)
export(X11)
export(q)
@@ -124,7 +125,6 @@ export(setwd)
export(win.graph)
export(windows)
export(x11)
-exportClasses(RK.Output)
import(methods)
importFrom(grDevices,dev.copy)
importFrom(grDevices,dev.cur)
diff --git a/rkward/rbackend/rpackages/rkward/R/internal_debugger.R b/rkward/rbackend/rpackages/rkward/R/internal_debugger.R
index 3a2276cd5..08aee1b45 100644
--- a/rkward/rbackend/rpackages/rkward/R/internal_debugger.R
+++ b/rkward/rbackend/rpackages/rkward/R/internal_debugger.R
@@ -26,10 +26,18 @@
list ("calls"=calls, "functions"=funs, "environments"=envs, "locals"=locals, "relsrclines"=relsrclines)
}
-# get relative source location
-# NOTE: this requires R >= 2.13.0
+#' Get relative source location
+#'
+#' @param inner either an object containing source references, or an object of class
+#' \code{\link[base:srcref]{srcref}}.
+#' @param outer see \code{inner}.
+#' @return An integer or \code{NA}.
+#' @seealso \code{\link[utils:getSrcref]{getSrcref}},
+#' \code{\link[utils:getSrcFilename]{getSrcFilename}},
+#' \code{\link[utils:getSrcLocation]{getSrcLocation}}
#' @importFrom utils getSrcref getSrcFilename getSrcLocation
#' @export
+# NOTE: this requires R >= 2.13.0
rk.relative.src.line <- function (inner, outer) {
if (!inherits (inner, "srcref")) inner <- getSrcref (inner)
if (!inherits (outer, "srcref")) outer <- getSrcref (outer)
diff --git a/rkward/rbackend/rpackages/rkward/R/internal_graphics.R b/rkward/rbackend/rpackages/rkward/R/internal_graphics.R
index 96225ec56..fc1bce7e5 100644
--- a/rkward/rbackend/rpackages/rkward/R/internal_graphics.R
+++ b/rkward/rbackend/rpackages/rkward/R/internal_graphics.R
@@ -11,6 +11,7 @@
#'
#' @seealso \link{dev.new}, \link{RK}, \link{rk.embed.device}
#'
+#' @param ... arguments to be passed on to \code{dev.new()}.
#' @importFrom grDevices dev.new
#' @export
"rk.screen.device" <- function (...) {
diff --git a/rkward/rbackend/rpackages/rkward/R/public_graphics.R b/rkward/rbackend/rpackages/rkward/R/public_graphics.R
index 2eb5788cf..5772855dc 100644
--- a/rkward/rbackend/rpackages/rkward/R/public_graphics.R
+++ b/rkward/rbackend/rpackages/rkward/R/public_graphics.R
@@ -232,28 +232,44 @@
}
## NOTE: Adding an Rd-page for these makes "?X11" fail (R 3.0.0).
-# Overrides for platform specific R plotting devices
-#
-# These functions override the platform specific on-screen plotting devices by the same names.
-# The exact behavior depends on configuration settings, and can be one of: The original R device,
-# the original R device embedded using \code{rk.embed.device()}, or the call can be re-directed
-# to the \code{RK()} device. In the last case not all function arguments may be honored.
-#
-# @note If you want to use the \link{RK} device, you should call that, explicitly. These
-# overrides are provided to make it easy to use scripts that refer to the platform specific
-# plotting devices provided by R.
-#
-# @seealso \link{RK} \link{rk.embed.device} \link[grDevices]{X11} \link[grDevices]{Windows}
-#
-# @rdname DeviceOverrides
+#' Overrides for platform specific R plotting devices
+#'
+#' These functions override the platform specific on-screen plotting devices by the same names.
+#' The exact behavior depends on configuration settings, and can be one of: The original R device,
+#' the original R device embedded using \code{rk.embed.device()}, or the call can be re-directed
+#' to the \code{RK()} device. In the last case not all function arguments may be honored.
+#'
+#' @note If you want to use the \link{RK} device, you should call that, explicitly. These
+#' overrides are provided to make it easy to use scripts that refer to the platform specific
+#' plotting devices provided by R.
+#'
+#' @inheritParams grDevices::X11
+#' @inheritParams grDevices::windows
+#' @inheritParams grDevices::quartz
+#' @seealso \code{\link[rkward:RK]{RK}},
+#' \code{\link[rkward:rk.embed.device]{rk.embed.device}},
+#' \code{\link[grDevices:X11]{X11}},
+#' \code{\link[grDevices:windows]{windows}},
+#' \code{\link[grDevices:win.graph]{win.graph}},
+#' \code{\link[grDevices:quartz]{quartz}}
+#' @rdname DeviceOverrides
+#' @aliases X11
#' @export
"X11" <- .rk.make.device.wrapper ("X11")
+#' @rdname DeviceOverrides
+#' @aliases x11
#' @export
"x11" <- X11
+#' @rdname DeviceOverrides
+#' @aliases windows
#' @export
"windows" <- .rk.make.device.wrapper ("windows")
+#' @rdname DeviceOverrides
+#' @aliases win.graph
#' @export
"win.graph" <- .rk.make.device.wrapper ("win.graph") # NOTE: Has different formals() than windows()
+#' @rdname DeviceOverrides
+#' @aliases quartz
#' @export
"quartz" <- .rk.make.device.wrapper ("quartz")
@@ -289,18 +305,47 @@
.rk.variables$.rk.printer.devices[[as.character (dev.cur ())]] <- tf
}
-#' @importFrom grDevices dev.cur dev.set dev.copy dev.new
+#' Record screen device history and duplicate a screen device
+#'
+#' \code{rk.record.plot} is an environment to store the screen device history.
+#' You should not use the functions/variables in this environment directly, instead use
+#' the many wrapper functions as described below.
+#'
+#' @return
+#' \code{rk.plot.history.summary} returns a data.frame with messages.
+#' \code{rk.duplicate.device} returns the value of a \code{\link[grDevices:dev.copy]{dev.copy}} call.
+#' All other functions return \code{NULL} invisibly.
+#' @author Prasenjit Kapat \email{rkward-devel at kde.org}
+#' @seealso \code{\link[grDevices:recordPlot]{recordPlot}},
+#' \code{\link[grDevices:replayPlot]{replayPlot}},
+#' \code{\link[lattice:print.trellis]{print.trellis}},
+#' \code{\link[lattice:trellis.last.object]{trellis.last.object}},
+#' \url{rkward://page/rkward_plot_history}
+#' @rdname rk.record.plot
+#' @keywords device dynamic environment
#' @export
-"rk.duplicate.device" <- function (devId = dev.cur ())
-{
- rk.record.plot$duplicating.from.device <- devId
- on.exit (rk.record.plot$duplicating.from.device <- 1) # NULL device
- dev.set (devId)
- dev.copy (device = dev.new)
-}
-
+#' @examples
+#' \dontrun{
+#' .L. <- getOption ("rk.graphics.hist.max.length")
+#'
+#' local ({
+#' options ("rk.graphics.hist.max.length" = 150)
+#' x <- seq(-2*pi,2*pi,length=400)
+#' xlim <- range(x); ylim <- c(-1,1)
+#' n <- 100;
+#' for (i in seq_len (n)) {
+#' plot(x, sin(x-(i-1)*4*pi/n), type='l', xlim=xlim, ylim=ylim,
+#' bty='n', xlab='', ylab='', xaxt='n', yaxt='n')
+#' }
+#' })
+#'
+#' rk.first.plot ()
+#' for (i in 1:(rk.record.plot$sP.length-1)) rk.next.plot ()
+#'
+#' rk.clear.plot.history ()
+#' options ("rk.graphics.hist.max.length" = .L.)
+#' }
# A global history of various graphics calls;
-#' @export
"rk.record.plot" <- function ()
{
env <- environment()
@@ -1014,9 +1059,19 @@
}
rk.record.plot <- rk.record.plot ()
+#' @details
+#' \code{rk.toggle.plot.history} enables or disables the screen device history.
+#' You should \emph{not} use this function directly. Instead, use the checkbox in
+#' Settings->Configure RKWard->Onscreen Graphics->Screen device history.
+#' After the needed initialization / clean up, it sets the option variable
+#' \code{"rk.enable.graphics.history"} to \code{x}.
+#'
+#' @param x a logical (not \code{NA}), whether to enable the screen device history.
+#' @rdname rk.record.plot
+#' @aliases rk.toggle.plot.history
+#' @export
# Users should use only these wrappers:
# 1 is always the null device
-#' @export
"rk.toggle.plot.history" <- function (x = TRUE)
{
if (x) {
@@ -1027,7 +1082,16 @@ rk.record.plot <- rk.record.plot ()
options ("rk.enable.graphics.history" = x)
invisible ()
}
+
+#' @details
+#' The functions \code{rk.first.plot}, \code{rk.previous.plot}, \code{rk.next.plot}, and
+#' \code{rk.last.plot} provide browing actions to respective plots saved in the history
+#' on the specified device (\code{devId}).
+#'
+#' @param devId integer, the screen device on which an action is to be performed.
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.first.plot
#' @export
"rk.first.plot" <- function (devId = dev.cur ())
{
@@ -1035,6 +1099,8 @@ rk.record.plot <- rk.record.plot ()
rk.record.plot$showFirst (devId)
}
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.previous.plot
#' @export
"rk.previous.plot" <- function (devId = dev.cur ())
{
@@ -1042,6 +1108,8 @@ rk.record.plot <- rk.record.plot ()
rk.record.plot$showPrevious (devId)
}
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.next.plot
#' @export
"rk.next.plot" <- function (devId = dev.cur ())
{
@@ -1049,52 +1117,100 @@ rk.record.plot <- rk.record.plot ()
rk.record.plot$showNext (devId)
}
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.last.plot
#' @export
"rk.last.plot" <- function (devId = dev.cur ())
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$showLast (devId)
}
+#' @details
+#' \code{rk.goto.plot} provides a one step jump action to the plot specified
+#' by \code{index} on the specified device (\code{devId}).
+#'
+#' @param index integer, which plot to jump to.
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.goto.plot
#' @export
"rk.goto.plot" <- function (devId = dev.cur (), index=1)
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$showPlot (devId, index)
}
+#' @details
+#' \code{rk.force.append.plot} forcefully append the currently displayed plot to the history.
+#' This function ignores the type of plot (graphics/lattice) and by-passes the general
+#' recording mechanism, as a result the plot call can not be identified.
+#'
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.force.append.plot
#' @export
"rk.force.append.plot" <- function (devId = dev.cur ())
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$forceAppend (devId)
}
+#' @details
+#' \code{rk.removethis.plot} removes the plot displayed on the specified device from history.
+#' If there are more than one device showing the same plot then removing from one device does
+#' not wipe it from the other devices. They can be re-added to the history from the other
+#' devices.
+#'
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.removethis.plot
#' @export
"rk.removethis.plot" <- function (devId = dev.cur ())
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$removePlot (devId)
}
+#' @details
+#' \code{rk.clear.plot.history} clears the screen device history.
+#'
+#' @rdname rk.record.plot
+#' @aliases rk.clear.plot.history
#' @export
"rk.clear.plot.history" <- function ()
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$clearHistory ()
}
+#' @details
+#' \code{rk.show.plot.info} shows some extra information regarding the
+#' displayed plot on the specified device, when available.
+#'
#' @importFrom grDevices dev.cur
+#' @rdname rk.record.plot
+#' @aliases rk.show.plot.info
#' @export
"rk.show.plot.info" <- function (devId = dev.cur ())
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$showPlotInfo (devId)
}
+#' @param lmax integer, the desired history limit.
+#' @rdname rk.record.plot
+#' @aliases rk.verify.plot.hist.limits
#' @export
"rk.verify.plot.hist.limits" <- function (lmax)
{
if (!getOption ("rk.enable.graphics.history")) return (invisible ())
rk.record.plot$.verify.hist.limits (as.integer (lmax))
}
+#' @details
+#' \code{rk.plot.history.summary} provides some summaries of the screen device history.
+#'
+#' @param which integer identifying the device. If \code{NULL} defaults to all devices.
+#' @param type one of \code{"devices"} or \code{"history"}, the type of summary to be
+#' printed. \code{type = "devices"} provides summary of all or one device(s),
+#' depending on the value of \code{which}.
+#' \code{type = "history"} provides summary of the entire stored history.
+#' @rdname rk.record.plot
+#' @aliases rk.plot.history.summary
#' @export
"rk.plot.history.summary" <- function (which = NULL, type = c ("devices", "history"))
{
@@ -1106,9 +1222,29 @@ rk.record.plot <- rk.record.plot ()
NULL)
ret
}
-#' 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.
-#'
+#' @details
+#' \code{rk.duplicate.device} duplicates the specified screen device.
+#' The plot on the new device behaves independently of the one it was duplicated from.
+#'
+#' @importFrom grDevices dev.cur dev.set dev.copy dev.new
+#' @rdname rk.record.plot
+#' @aliases rk.duplicate.device
+#' @export
+"rk.duplicate.device" <- function (devId = dev.cur ())
+{
+ rk.record.plot$duplicating.from.device <- devId
+ on.exit (rk.record.plot$duplicating.from.device <- 1) # NULL device
+ dev.set (devId)
+ dev.copy (device = dev.new)
+}
+#' @details
+#' \code{rk.without.plot.history} runs a (plotting) action, without recording anything in the
+#' plot history. Internally, the plot history option is turned off for the duration of the
+#' action.
+#'
+#' @param expr the plot call to evaluate.
+#' @rdname rk.record.plot
+#' @aliases rk.without.plot.history
#' @export
"rk.without.plot.history" <- function (expr)
{
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
index af173b0b0..b9ea9a7cf 100755
--- a/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
@@ -51,7 +51,7 @@
#' @param wait a logical (not NA) indicating whether the R interpreter should
#' wait for the user's action, or run it asynchronously.
#' @param choices a vector, coerced into a character vector.
-#' @param preselct a vector, coerced into a character vector, items to be
+#' @param preselect a vector, coerced into a character vector, items to be
#' preselected.
#' @param multiple a logical (not NA), when \code{TRUE} multiple selection
#' selection is allowed.
@@ -115,6 +115,7 @@
else return (NULL) # cancelled
}
+#' @param ... currently unused.
#' @export
#' @rdname rk.show.messages
"rk.askYesNo" <- function (msg, default = TRUE, prompts = c("yes", "no", "cancel"), caption = gettext("Question"), is.rk.askYesNo=TRUE, ...) {
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.completion-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.completion-functions.R
index 1fc41db67..98b12dc12 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.completion-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.completion-functions.R
@@ -7,6 +7,8 @@
#' These are currently not exported, as they are not intended to be use in user code
#' The API may or may not be stable.
#'
+#' @param fragment string fragment to complete.
+#' @param type one of \code{"funargs"}, \code{"$"}, \code{"@"}, \code{"::"}, \code{":::"}, or \code{"?"}.
#' @rdname rk.get.completions
#'
".rk.completions" <- function(fragment, type) {
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
index 39cc0821d..30ceed1a3 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
@@ -55,7 +55,7 @@
#' placed next to x, with file name extension ".css". Only effective when initializing a
#' (non-existing) output file.
#' @param silent Set to true to avoid the output window being raised in the frontend.
-#' @param flush.images. If true, any images used in the output file will be deleted as well.
+#' @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.
#' @param ... Further parameters passed to rk.set.output.html.file()
#' @return \code{rk.get.tempfile.name}, \code{rk.get.output.html.file}, \code{rk.get.workspace.url}, and
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R
index 516558ceb..ba0d6b763 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R
@@ -121,6 +121,7 @@
}
# get descriptive strings for each of the arguments in ...
+#' @param ... arguments to get descriptive strings for.
#' @rdname rk.label
#' @export
"rk.get.description" <- function (..., paste.sep, is.substitute=FALSE) {
@@ -173,6 +174,7 @@
}
# this is basically copied from R-base table (). Returns the arguments passed to ... as a character vector
+#' @param deparse.level integer.
#' @rdname rk.label
#' @export
"rk.list.names" <- function(..., deparse.level=2) {
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.output.R b/rkward/rbackend/rpackages/rkward/R/rk.output.R
index 0ca2fd2b3..5365fc869 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.output.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.output.R
@@ -47,7 +47,7 @@
#' @returns NULL
#' @field id An internal identifier. NULL for a closed output. This should be treated as read-only, but you can use this to test whether two output handles are the same.
#' @import methods
-#' @exportClass RK.Output
+#' @export RK.Output
#'
#' @examples
#' \dontrun{
@@ -128,6 +128,8 @@ Do not write anything to the target filename, directly! This is purely for infor
else ret[[1]]
}
+#' @param import logical, whether to import file \code{filename}.
+#' @param delete logical, whether to delete file \code{filename} and all its images on exit.
#' @export
#' @rdname RK.Output
"rk.import.legacy.output" <- function(filename=file.path(rk.home(), "rk_out.html"), import=TRUE, delete=FALSE) {
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R
index 577876a71..8c34debac 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R
@@ -51,6 +51,7 @@
#' @param 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.
+#' @param ... Additional arguments to be passed on to \code{\link[R2HTML:HTML]{HTML}}.
#' @return \code{rk.describe.alternatives} returns a string while all other
#' functions return \code{NULL}, invisibly.
#' @author Thomas Friedrichsmeier \email{rkward-devel@@kde.org}
@@ -96,7 +97,7 @@
#' })
#' } else {}
#' }
-"rk.print" <- function(x,...) {
+"rk.print" <- function(x, ...) {
if (inherits (x, "htmlwidget")) {
requireNamespace ("htmlwidgets", quietly = TRUE)
name <- deparse (substitute (x))
@@ -110,7 +111,7 @@
} else {
htmlfile <- rk.get.output.html.file()
if(requireNamespace ("R2HTML", quietly = TRUE)) {
- R2HTML::HTML(x, file=htmlfile,...)
+ R2HTML::HTML(x, file=htmlfile, ...)
}
}
}
@@ -298,6 +299,8 @@
invisible (NULL)
}
+# what exactly does 'highlight' do?
+#' @param highlight logical.
#' @export
#' @rdname rk.capture.output
"rk.end.capture.output" <- function (highlight = FALSE) {
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R
index 50c28beb9..eb6078561 100644
--- a/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R
@@ -103,13 +103,14 @@
#' Slightly smarter variant of old.packages()
#'
-#' For most purposes, this function is identical to old.packages(). However, if the same
+#' For most purposes, this function is identical to \code{\link[utils:old.packages]{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.
#'
+#' @inheritParams utils::old.packages
#' @return a character vector of packages which are really old
#'
#' @author Thomas Friedrichsmeier \email{rkward-devel@@kde.org}
diff --git a/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd b/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
new file mode 100644
index 000000000..e2c402eba
--- /dev/null
+++ b/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
@@ -0,0 +1,166 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/public_graphics.R
+\name{X11}
+\alias{X11}
+\alias{x11}
+\alias{windows}
+\alias{win.graph}
+\alias{quartz}
+\title{Overrides for platform specific R plotting devices}
+\usage{
+X11(
+ display = "",
+ width,
+ height,
+ pointsize,
+ gamma,
+ bg,
+ canvas,
+ fonts,
+ family,
+ xpos,
+ ypos,
+ title,
+ type,
+ antialias,
+ symbolfamily
+)
+
+x11(
+ display = "",
+ width,
+ height,
+ pointsize,
+ gamma,
+ bg,
+ canvas,
+ fonts,
+ family,
+ xpos,
+ ypos,
+ title,
+ type,
+ antialias,
+ symbolfamily
+)
+
+windows(
+ width = getOption("rk.screendevice.width"),
+ height = getOption("rk.screendevice.height"),
+ pointsize = 12
+)
+
+win.graph(
+ width = getOption("rk.screendevice.width"),
+ height = getOption("rk.screendevice.height"),
+ pointsize = 12
+)
+
+quartz(
+ title,
+ width,
+ height,
+ pointsize,
+ family,
+ antialias,
+ type,
+ file = NULL,
+ bg,
+ canvas,
+ dpi
+)
+}
+\arguments{
+\item{display}{the display on which the graphics window will appear.
+ The default is to use the value in the user's environment variable
+ \env{DISPLAY}. This is ignored (with a warning) if an X11 device is
+ already open on another display.}
+
+\item{width, height}{the width and height of the plotting window, in
+ inches. If \code{NA}, taken from the resources and if
+ not specified there defaults to \code{7} inches. See also
+ \sQuote{Resources}.}
+
+\item{pointsize}{the default pointsize to be used. Defaults to \code{12}.}
+
+\item{gamma}{gamma correction fudge factor.
+ Colours in R are sRGB; if your monitor does not conform to
+ sRGB, you might be able to improve things by tweaking this
+ parameter to apply additional gamma correction to the RGB channels.
+ By default 1 (no additional gamma correction).}
+
+\item{bg}{colour, the initial background colour. Default
+ \code{"transparent"}.}
+
+\item{canvas}{colour. The colour of the canvas, which is visible only
+ when the background colour is transparent. Should be an opaque colour
+ (and any alpha value will be ignored). Default \code{"white"}.}
+
+\item{fonts}{for \code{type = "Xlib"} only:
+ X11 font description strings into which weight, slant and
+ size will be substituted. There are two, the first for fonts 1 to 4
+ and the second for font 5, the symbol font. See section \sQuote{Fonts}.}
+
+\item{family}{The default family: a length-one character string. This
+ is primarily intended for cairo-based devices, but for \code{type =
+ "Xlib"}, the \code{\link[grDevices]{X11Fonts}()} database is used to map family
+ names to \code{fonts} (and this argument takes precedence over that
+ one).}
+
+\item{xpos, ypos}{integer: initial position of the top left corner of the
+ window, in pixels. Negative values are from the opposite corner,
+ e.g.\ifelse{latex}{\out{~}}{ }{}\code{xpos = -100} says the top right corner should be 100 pixels
+ from the right edge of the screen. If \code{NA} (the default),
+ successive devices are cascaded in 20 pixel steps from the top left.
+ See also \sQuote{Resources}.}
+
+\item{title}{character string, up to 100 bytes. With the default,
+ \code{""}, a suitable title is created internally. A C-style format
+ for an integer will be substituted by the device number (see the
+ \code{file} argument to \code{\link[grDevices]{postscript}} for further
+ details). How non-ASCII titles are handled is
+ implementation-dependent.}
+
+\item{type}{character string, one of \code{"Xlib"}, \code{"cairo"},
+ \code{"nbcairo"} or \code{"dbcairo"}. Only the first will be
+ available if the system was compiled without support for
+ cairographics. The default is \code{"cairo"} where \R was built
+ using \code{pangocairo} (often not the case on macOS), otherwise
+ \code{"Xlib"}.}
+
+\item{antialias}{for cairo types, the type of anti-aliasing (if any)
+ to be used. One of \code{c("default", "none", "gray", "subpixel")}.}
+
+\item{symbolfamily}{for cairo-based devices only:
+ a length-one character string that specifies the font family to
+ be used as the "symbol" font (e.g., for \link[grDevices]{plotmath} output).
+ The default value is "default", which means that R will choose
+ a default "symbol" font based on the graphics device capabilities.}
+
+\item{file}{an optional target for the graphics device. The default,
+ \code{NULL}, selects a default name where one is needed. See
+ \sQuote{Details} for more information.}
+
+\item{dpi}{resolution of the output. The default (\code{NA_real_})
+ for an on-screen display defaults to the resolution of
+ the main screen, and to 72 dpi otherwise. See \sQuote{Details}.}
+}
+\description{
+These functions override the platform specific on-screen plotting devices by the same names.
+The exact behavior depends on configuration settings, and can be one of: The original R device,
+the original R device embedded using \code{rk.embed.device()}, or the call can be re-directed
+to the \code{RK()} device. In the last case not all function arguments may be honored.
+}
+\note{
+If you want to use the \link{RK} device, you should call that, explicitly. These
+ overrides are provided to make it easy to use scripts that refer to the platform specific
+ plotting devices provided by R.
+}
+\seealso{
+\code{\link[rkward:RK]{RK}},
+ \code{\link[rkward:rk.embed.device]{rk.embed.device}},
+ \code{\link[grDevices:X11]{X11}},
+ \code{\link[grDevices:windows]{windows}},
+ \code{\link[grDevices:win.graph]{win.graph}},
+ \code{\link[grDevices:quartz]{quartz}}
+}
diff --git a/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd b/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
index 62bb4eec2..09889b11f 100644
--- a/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
@@ -26,6 +26,10 @@ return the currently active output in this case (creating and/or activating an o
\item{all}{If \code{TRUE}, return a list of all currently loaded output directories.}
+\item{import}{logical, whether to import file \code{filename}.}
+
+\item{delete}{logical, whether to delete file \code{filename} and all its images on exit.}
+
\item{overwrite}{If \code{TRUE}, RKWard will overwrite any existing output when saving, or discard any existing modifications when closing or reverting an output. If \code{FALSE}, trying
to overwrite/discard existing files/modifications will result in an error. If \code{NULL} (the default), the frontend will ask what to do in this case.}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd b/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
index 0c8a74b8e..f4f9b76d4 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
@@ -29,6 +29,8 @@ rk.end.capture.output(highlight = FALSE)
\code{rk.capture.output} Starts capturing output.
\code{rk.end.capture.output} Stops capturing output, and returns the recorded output in a string.}
+
+\item{highlight}{logical.}
}
\description{
This feature records and / or redirects output similar to the \code{\link{sink}} and \code{\link{capture.output}}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.get.completions.Rd b/rkward/rbackend/rpackages/rkward/man/rk.get.completions.Rd
index 3266af2bd..f347fbdd8 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.get.completions.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.get.completions.Rd
@@ -6,6 +6,11 @@
\usage{
.rk.completions(fragment, type)
}
+\arguments{
+\item{fragment}{string fragment to complete.}
+
+\item{type}{one of \code{"funargs"}, \code{"$"}, \code{"@"}, \code{"::"}, \code{":::"}, or \code{"?"}.}
+}
\description{
These are currently not exported, as they are not intended to be use in user code
The API may or may not be stable.
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd b/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
index 6b0d33b89..9c3fbf03e 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
@@ -67,11 +67,11 @@ placed next to x, with file name extension ".css". Only effective when initializ
\item{silent}{Set to true to avoid the output window being raised in the frontend.}
+\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{...}{Further parameters passed to rk.set.output.html.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}, \code{rk.get.workspace.url}, and
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.label.Rd b/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
index 43cf484b7..34065fc2d 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
@@ -36,9 +36,13 @@ rk.list.names(..., deparse.level = 2)
\item{fill}{a logical or character. See Details.}
+\item{...}{arguments to get descriptive strings for.}
+
\item{paste.sep}{a string, used as the \code{collapse} argument for paste.}
\item{is.substitute}{a logical (not NA). See Details.}
+
+\item{deparse.level}{integer.}
}
\value{
\code{rk.set.label} returns the result of the evaluation of "setting
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd b/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
index bda929921..4211425c7 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
@@ -15,11 +15,53 @@ rk.old.packages(
type = getOption("pkgType")
)
}
+\arguments{
+\item{lib.loc}{character vector describing the location of R
+ library trees to search through (and update packages therein), or
+ \code{NULL} for all known trees (see \code{\link{.libPaths}}).}
+
+\item{repos}{
+ character vector, the base URL(s) of the repositories
+ to use, e.g., the URL of a CRAN mirror such as
+ \code{"https://cloud.r-project.org"}.
+ }
+
+\item{contriburl}{URL(s) of the contrib sections of the
+ repositories. Use this argument if your repository is
+ incomplete. Overrides argument \code{repos}.
+ Incompatible with \code{type = "both"}.
+ }
+
+\item{instPkgs}{
+ by default all installed packages,
+ \code{\link[utils]{installed.packages}(lib.loc = lib.loc)}. A subset can be
+ specified; currently this must be in the same (character matrix)
+ format as returned by \code{installed.packages()}.
+ }
+
+\item{method}{Download method, see \code{\link[utils]{download.file}}.
+ Unused if a non-\code{NULL} \code{available} is supplied.}
+
+\item{available}{
+ an object as returned by \code{\link[utils]{available.packages}}
+ listing packages available at the repositories, or \code{NULL} which
+ makes an internal call to \code{available.packages}.
+ Incompatible with \code{type = "both"}.
+ }
+
+\item{checkBuilt}{If \code{TRUE}, a package built under an earlier
+ major.minor version of \R (e.g., \code{3.4}) is considered to be
+ \sQuote{old}.}
+
+\item{type}{character, indicating the type of package to download and
+ install. See \code{\link[utils]{install.packages}}.
+ }
+}
\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
+For most purposes, this function is identical to \code{\link[utils:old.packages]{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,
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd b/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
index 58b87423e..e83aa170d 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
@@ -1,3 +1,6 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/public_graphics.R
+\docType{data}
\name{rk.record.plot}
\alias{rk.record.plot}
\alias{rk.toggle.plot.history}
@@ -13,89 +16,107 @@
\alias{rk.verify.plot.hist.limits}
\alias{rk.plot.history.summary}
\alias{rk.duplicate.device}
-
+\alias{rk.without.plot.history}
\title{Record screen device history and duplicate a screen device}
-\description{
- TODO TODO
+\format{
+An object of class \code{environment} of length 57.
}
-
\usage{
+rk.record.plot
+
rk.toggle.plot.history(x = TRUE)
rk.first.plot(devId = dev.cur())
+
rk.previous.plot(devId = dev.cur())
+
rk.next.plot(devId = dev.cur())
+
rk.last.plot(devId = dev.cur())
-rk.goto.plot(devId = dev.cur(), index=1)
+
+rk.goto.plot(devId = dev.cur(), index = 1)
rk.force.append.plot(devId = dev.cur())
+
rk.removethis.plot(devId = dev.cur())
rk.clear.plot.history()
rk.show.plot.info(devId = dev.cur())
+
+rk.verify.plot.hist.limits(lmax)
+
rk.plot.history.summary(which = NULL, type = c("devices", "history"))
rk.duplicate.device(devId = dev.cur())
-}
-\arguments{
- \item{devId, which}{ an integer,
- the screen device on which an action is to be performed.}
- \item{x}{ a logical (not NA), whether to enable the screen device history.}
- \item{index}{ an integer, which plot to jump to?}
- \item{type}{ a string, either \code{"devices"} or \code{"history"},
- the type of summary to be printed.}
+rk.without.plot.history(expr)
}
+\arguments{
+\item{x}{a logical (not \code{NA}), whether to enable the screen device history.}
-\details{
- TODO TODO
-
- \code{rk.record.plot} is an environment to store the screen device history. You should not use the functions / variables in this environment directly,
- instead use the many wrapper functions as described below.
-
- \code{rk.toggle.plot.history} enables or disables the screen device history. You should not use this function. Instead use the checkbox in Settings->Configure RKWard->Onscreen Graphics->Screen device history. After the needed initialization / clean up,
- it sets the option variable \code{"rk.enable.graphics.history"} to \code{x}.
-
- \code{rk.first.plot}, \code{rk.previous.plot}, \code{rk.next.plot},
- \code{rk.last.plot} these functions provide browing actions to respective plots saved in the history on the specified device (\code{devId}).
-
- \code{rk.goto.plot} this function provides a one step jump action to the plot specified by \code{index} on the specified device (\code{devId}).
-
- \code{rk.force.append.plot} forcefully append the currently displayed plot to the history. This function ignores the type of plot (graphics / lattice) and by-passes the general recording mechanism,
- as a result the plot call can not be identified.
-
- \code{rk.removethis.plot} removes the plot displayed on the specified device from history. If there are more than one device showing the same plot then removing from one device does not wipe it from the other devices. They can be re-added to the history from the other devices.
-
- \code{rk.clear.plot.history} clears the screen device history.
-
- \code{rk.show.plot.info} when available,
- shows some extra information regarding the displayed plot on the specified device.
-
- \code{rk.plot.history.summary} provides some summaries of the screen device history. \code{type = "devices"} provides summary of all or one device(s) depending on whether \code{which = NULL} or \code{which} is a single number identifying the device. \code{type = "history"} provides summary of the entire stored history.
-
- \code{rk.duplicate.device} duplicates the specified screen device. The plot on the new device behaves independently of the one it was duplicated from.
-}
+\item{devId}{integer, the screen device on which an action is to be performed.}
+
+\item{index}{integer, which plot to jump to.}
+
+\item{lmax}{integer, the desired history limit.}
+
+\item{which}{integer identifying the device. If \code{NULL} defaults to all devices.}
+
+\item{type}{one of \code{"devices"} or \code{"history"}, the type of summary to be
+printed. \code{type = "devices"} provides summary of all or one device(s),
+depending on the value of \code{which}.
+\code{type = "history"} provides summary of the entire stored history.}
+\item{expr}{the plot call to evaluate.}
+}
\value{
- Except those mentioned below, the rest return \code{NULL} invisibly.
-
- \code{rk.plot.history.summary} returns a data.frame with some messages.
-
- \code{rk.duplicate.device} returns the value of a \code{dev.copy} call.
+\code{rk.plot.history.summary} returns a data.frame with messages.
+ \code{rk.duplicate.device} returns the value of a \code{\link[grDevices:dev.copy]{dev.copy}} call.
+ All other functions return \code{NULL} invisibly.
}
-\author{Prasenjit Kapat \email{rkward-devel at kde.org}}
-
-\section{Warning}{
- TODO TODO
+\description{
+\code{rk.record.plot} is an environment to store the screen device history.
+You should not use the functions/variables in this environment directly, instead use
+the many wrapper functions as described below.
}
+\details{
+\code{rk.toggle.plot.history} enables or disables the screen device history.
+You should \emph{not} use this function directly. Instead, use the checkbox in
+Settings->Configure RKWard->Onscreen Graphics->Screen device history.
+After the needed initialization / clean up, it sets the option variable
+\code{"rk.enable.graphics.history"} to \code{x}.
-\seealso{
- \code{\link{recordPlot}}, \code{\link{replayPlot}}
- \code{\link{print.trellis}}, \code{\link{trellis.last.object}}
- \url{rkward://page/rkward_plot_history}
-}
+The functions \code{rk.first.plot}, \code{rk.previous.plot}, \code{rk.next.plot}, and
+\code{rk.last.plot} provide browing actions to respective plots saved in the history
+on the specified device (\code{devId}).
+
+\code{rk.goto.plot} provides a one step jump action to the plot specified
+by \code{index} on the specified device (\code{devId}).
+
+\code{rk.force.append.plot} forcefully append the currently displayed plot to the history.
+This function ignores the type of plot (graphics/lattice) and by-passes the general
+recording mechanism, as a result the plot call can not be identified.
+
+\code{rk.removethis.plot} removes the plot displayed on the specified device from history.
+If there are more than one device showing the same plot then removing from one device does
+not wipe it from the other devices. They can be re-added to the history from the other
+devices.
+\code{rk.clear.plot.history} clears the screen device history.
+
+\code{rk.show.plot.info} shows some extra information regarding the
+displayed plot on the specified device, when available.
+
+\code{rk.plot.history.summary} provides some summaries of the screen device history.
+
+\code{rk.duplicate.device} duplicates the specified screen device.
+The plot on the new device behaves independently of the one it was duplicated from.
+
+\code{rk.without.plot.history} runs a (plotting) action, without recording anything in the
+plot history. Internally, the plot history option is turned off for the duration of the
+action.
+}
\examples{
\dontrun{
.L. <- getOption ("rk.graphics.hist.max.length")
@@ -106,7 +127,7 @@ local ({
xlim <- range(x); ylim <- c(-1,1)
n <- 100;
for (i in seq_len (n)) {
- plot(x, sin(x-(i-1)*4*pi/n), type='l', xlim=xlim, ylim=ylim,
+ plot(x, sin(x-(i-1)*4*pi/n), type='l', xlim=xlim, ylim=ylim,
bty='n', xlab='', ylab='', xaxt='n', yaxt='n')
}
})
@@ -118,6 +139,16 @@ rk.clear.plot.history ()
options ("rk.graphics.hist.max.length" = .L.)
}
}
+\seealso{
+\code{\link[grDevices:recordPlot]{recordPlot}},
+ \code{\link[grDevices:replayPlot]{replayPlot}},
+ \code{\link[lattice:print.trellis]{print.trellis}},
+ \code{\link[lattice:trellis.last.object]{trellis.last.object}},
+ \url{rkward://page/rkward_plot_history}
+}
+\author{
+Prasenjit Kapat \email{rkward-devel at kde.org}
+}
\keyword{device}
\keyword{dynamic}
\keyword{environment}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.relative.src.line.Rd b/rkward/rbackend/rpackages/rkward/man/rk.relative.src.line.Rd
new file mode 100644
index 000000000..847b3a24e
--- /dev/null
+++ b/rkward/rbackend/rpackages/rkward/man/rk.relative.src.line.Rd
@@ -0,0 +1,25 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/internal_debugger.R
+\name{rk.relative.src.line}
+\alias{rk.relative.src.line}
+\title{Get relative source location}
+\usage{
+rk.relative.src.line(inner, outer)
+}
+\arguments{
+\item{inner}{either an object containing source references, or an object of class
+\code{\link[base:srcref]{srcref}}.}
+
+\item{outer}{see \code{inner}.}
+}
+\value{
+An integer or \code{NA}.
+}
+\description{
+Get relative source location
+}
+\seealso{
+\code{\link[utils:getSrcref]{getSrcref}},
+ \code{\link[utils:getSrcFilename]{getSrcFilename}},
+ \code{\link[utils:getSrcLocation]{getSrcLocation}}
+}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.results.Rd b/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
index 9b86fe748..e7cb9502a 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
@@ -25,6 +25,8 @@ rk.describe.alternative(x)
\item{x}{any R object to be printed/exported. A suitable list in case of
\code{rk.describe.alternative}.}
+\item{...}{Additional arguments to be passed on to \code{\link[R2HTML:HTML]{HTML}}.}
+
\item{code}{a character vector (single string) of R code}
\item{title}{a string, used as a header for the html output}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd b/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
index 3648cf85c..58362cef5 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
@@ -6,6 +6,9 @@
\usage{
rk.screen.device(...)
}
+\arguments{
+\item{...}{arguments to be passed on to \code{dev.new()}.}
+}
\description{
Depending on your use case, you should use \code{dev.new()}, \code{RK()} or \code{rk.embed.device()}, instead.
}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd b/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
index c9f25c4f8..2011a1b6e 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
@@ -78,8 +78,13 @@ separated by \code{/} characters.}
via \code{options("askYesNo"=rk.askYesNo)} because otherwise we'd either need more
complicated function code there, fail with an error or end up in an infinite loop.}
+\item{...}{currently unused.}
+
\item{choices}{a vector, coerced into a character vector.}
+\item{preselect}{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.}
@@ -93,9 +98,6 @@ will be used, instead. E.g. \code{initial="#images"}.}
\item{mode}{one of \code{"file"} (select one file), \code{"files"} (select one or more files),
\code{"dir"} (select a directory), or \code{"newfile"} (set path for a new file).}
-
-\item{preselct}{a vector, coerced into a character vector, items to be
-preselected.}
}
\value{
\code{rk.show.message} always returns \code{TRUE}, invisibly.
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd b/rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd
deleted file mode 100644
index 7cf592964..000000000
--- a/rkward/rbackend/rpackages/rkward/man/rk.without.plot.history.Rd
+++ /dev/null
@@ -1,13 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/public_graphics.R
-\name{rk.without.plot.history}
-\alias{rk.without.plot.history}
-\title{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.}
-\usage{
-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.
-}
More information about the rkward-tracker
mailing list