[rkward] rkward/rbackend/rpackages/rkward: rebuilt 'rkward' package
m.eik michalke
null at kde.org
Tue May 22 16:56:45 UTC 2018
Git commit dec238eb509af1d15780b07d3951712dfb0466ae by m.eik michalke.
Committed on 22/05/2018 at 16:52.
Pushed by meikm into branch 'master'.
rebuilt 'rkward' package
- was necessary to add rk.askYesNo() to the NAMESPACE file
- while at it, let roxygen2 do its thing and fixed some minor issues like line breaks
or old *-package.R format
M +16 -16 rkward/rbackend/rpackages/rkward/DESCRIPTION
M +1 -1 rkward/rbackend/rpackages/rkward/NAMESPACE
M +1 -1 rkward/rbackend/rpackages/rkward/R/internal.R
M +20 -2 rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
M +11 -13 rkward/rbackend/rpackages/rkward/R/rkward-package.R
M +6 -6 rkward/rbackend/rpackages/rkward/inst/CITATION
M +4 -2 rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
M +10 -5 rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
M +14 -7 rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
M +6 -3 rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
M +8 -4 rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
M +6 -3 rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
M +14 -7 rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
M +21 -1 rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
M +6 -3 rkward/rbackend/rpackages/rkward/man/rk.switch.frontend.language.Rd
M +14 -7 rkward/rbackend/rpackages/rkward/man/rk.with.window.hints.Rd
M +17 -9 rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
https://commits.kde.org/rkward/dec238eb509af1d15780b07d3951712dfb0466ae
diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index 80585be0..0431c5e6 100644
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -1,26 +1,28 @@
Package: rkward
Type: Package
Title: Provides functions related to the RKWard GUI
-Author: Thomas Friedrichsmeier <thomas.friedrichsmeier at ruhr-uni-bochum.de> and
- the RKWard Team <rkward-devel at kde.org>
+Description: 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
+ <thomas.friedrichsmeier at ruhr-uni-bochum.de> and the RKWard Team
+ <rkward-devel at kde.org>
Maintainer: RKWard-devel mailing list <rkward-devel at kde.org>
-Depends:
- R (>= 2.9.0),methods
-Description: 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.
+Depends: R (>= 2.9.0),methods
+URL: https://rkward.kde.org
+BugReports: https://rkward.kde.org/Bugs
License: GPL (>= 2)
Encoding: UTF-8
LazyLoad: yes
-URL: http://rkward.kde.org
Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
- email="thomas.friedrichsmeier at ruhr-uni-bochum.de", role=c("aut")),
- person(given="RKWard-devel", family="mailing list",
- email="rkward-devel at kde.org", role=c("cre","ctb")))
+ email="thomas.friedrichsmeier at ruhr-uni-bochum.de",
+ role=c("aut")), person(given="the RKWard", family="team",
+ email="rkward-devel at kde.org", role=c("cre","ctb")))
Version: 0.7.1
-Date: 2018-04-20
-Collate:
+Date: 2018-05-22
+RoxygenNote: 6.0.1
+Collate:
'base_overrides.R'
'internal.R'
'internal_debugger.R'
@@ -40,5 +42,3 @@ Collate:
'rk.utility-functions.R'
'rk.workspace-functions.R'
'rkward-package.R'
- 'ver.R'
-RoxygenNote: 6.0.1
diff --git a/rkward/rbackend/rpackages/rkward/NAMESPACE b/rkward/rbackend/rpackages/rkward/NAMESPACE
index 5d7c6cd3..f769f386 100644
--- a/rkward/rbackend/rpackages/rkward/NAMESPACE
+++ b/rkward/rbackend/rpackages/rkward/NAMESPACE
@@ -1,7 +1,6 @@
# Generated by roxygen2: do not edit by hand
export(.onAttach)
-export(.rk.app.version)
export(.rk.backups)
export(.rk.cached.available.packages)
export(.rk.callstack.info)
@@ -52,6 +51,7 @@ export(q)
export(quartz)
export(quit)
export(require)
+export(rk.askYesNo)
export(rk.assign.preview.data)
export(rk.call.plugin)
export(rk.clear.plot.history)
diff --git a/rkward/rbackend/rpackages/rkward/R/internal.R b/rkward/rbackend/rpackages/rkward/R/internal.R
old mode 100644
new mode 100755
index 256ebc88..5250c8c5
--- a/rkward/rbackend/rpackages/rkward/R/internal.R
+++ b/rkward/rbackend/rpackages/rkward/R/internal.R
@@ -34,7 +34,7 @@
eval (substitute (attr (x, ".rk.invalid.fields") <<- l))
}
-#' Work around some peculiarities in R's handling of levels
+# Work around some peculiarities in R's handling of levels
#' @export
".rk.set.levels" <- function (var, levels) {
if (is.factor (var)) {
diff --git a/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R b/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
old mode 100644
new mode 100755
index 771abc0d..617dbfab
--- a/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
+++ b/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
@@ -15,6 +15,8 @@
#'
#' @aliases rk.show.message rk.show.question rk.select.list
#' @param message a string for the content of the message box.
+#' @param msg like \code{message}, only the argument was renamed to mimic the formals of
+#' \code{askYesNo}.
#' @param caption a string for title of the message box.
#' @param 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
@@ -41,12 +43,19 @@
#' @param multiple a logical (not NA), when \code{TRUE} multiple selection
#' selection is allowed.
#' @param title a string, for the window title of the displayed list
+#' @param is.rk.askYesNo a logical value, you can safely ignore this argument if you call
+#' \code{rk.askYesNo} manually. This argument is needed if \code{rk.askYesNo} is set
+#' 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.
#' @return \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. If the dialog is closed
#' without clicking on any button, \code{NULL} is returned, as well.
#'
+#' \code{rk.askYesNo} has the same return values as \code{rk.show.question}, except
+#' it returns \code{NA} for \bold{Cancel} actions.
+#'
#' \code{rk.select.list} returns the value of \code{\link{select.list}}.
#' @author Thomas Friedrichsmeier \email{rkward-devel@@kde.org}
#' @seealso \code{\link{system}}, \code{\link{select.list}}
@@ -92,7 +101,16 @@
#' @export
#' @rdname rk.show.messages
-"rk.askYesNo" <- function (message, default = TRUE, prompts = c("yes", "no", "cancel"), caption = gettext("Question")) {
+"rk.askYesNo" <- function (msg, default = TRUE, prompts = c("yes", "no", "cancel"), caption = gettext("Question"), is.rk.askYesNo=TRUE, ...) {
+ if(is.function(prompts)){
+ # using options() to set the prompts value for askYesNo() to this function also replaces our prompts and we'd
+ # end up in an infinite loop. we can check for the presence of the "rk.askYesNo" argument to see if that's the case
+ if(isTRUE(is.rk.askYesNo)){
+ prompts <- eval(formals("rk.askYesNo")[["prompts"]])
+ } else {
+ stop(simpleError("'rk.askYesNo' was designed to be used as the function code of 'askYesNo' and cannot be given a function "))
+ }
+ } else {}
if(is.character(prompts)){
if(length(prompts) == 1){
prompts <- unlist(strsplit(prompts, "/"))
@@ -117,7 +135,7 @@
res <- .Call(
"rk.dialog",
caption,
- message,
+ msg,
button.yes,
button.no,
button.cancel,
diff --git a/rkward/rbackend/rpackages/rkward/R/rkward-package.R b/rkward/rbackend/rpackages/rkward/R/rkward-package.R
index bf9533e3..cb1bf585 100644
--- a/rkward/rbackend/rpackages/rkward/R/rkward-package.R
+++ b/rkward/rbackend/rpackages/rkward/R/rkward-package.R
@@ -1,24 +1,22 @@
-#' Provides functions related to the RKWard GUI.
+#' \packageDescription{rkward}
#'
+#' The DESCRIPTION file:
#' \tabular{ll}{
#' Package: \tab rkward\cr
#' Type: \tab Package\cr
-#' Version: \tab 0.6.3\cr
-#' Date: \tab 2014-10-30\cr
+#' Version: \tab 0.7.1\cr
+#' Date: \tab 2018-05-22\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.kde.org\cr
+#' URL: \tab https://rkward.kde.org\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.
+#' @title
+#' \packageTitle{rkward}
+#' @author
+#' \packageAuthor{rkward}
#'
-#' @aliases rkward-package
-#' @name rkward-package
-#' @docType package
-#' @title The rkward Package
-#' @author Thomas Friedrichsmeier, with contributions from RKWard-devel mailing list
-#' @keywords package
-NULL
+#' Maintainer: \packageMaintainer{rkward}
+"_PACKAGE"
diff --git a/rkward/rbackend/rpackages/rkward/inst/CITATION b/rkward/rbackend/rpackages/rkward/inst/CITATION
index 49eff875..45451adb 100644
--- a/rkward/rbackend/rpackages/rkward/inst/CITATION
+++ b/rkward/rbackend/rpackages/rkward/inst/CITATION
@@ -1,14 +1,14 @@
bibentry("Manual",
title="rkward: Provides functions related to the RKWard GUI",
author="Thomas Friedrichsmeier",
- year="2016",
- note="(Version 0.6.6)",
- url="http://rkward.kde.org",
+ year="2018",
+ note="(Version 0.7.1)",
+ url="https://rkward.kde.org",
textVersion =
- paste("Friedrichsmeier, T. (2016). ",
- "rkward: Provides functions related to the RKWard GUI (Version 0.6.6). ",
- "Available from http://rkward.kde.org",
+ paste("Friedrichsmeier, T. (2018). ",
+ "rkward: Provides functions related to the RKWard GUI (Version 0.7.1). ",
+ "Available from https://rkward.kde.org",
sep=""),
mheader = "To cite rkward in publications use:")
diff --git a/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd b/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
index af3eaf2a..037a689a 100644
--- a/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
@@ -16,7 +16,8 @@ RK(width = getOption("rk.screendevice.width"),
\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,
+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.}
@@ -27,6 +28,7 @@ including the device independent fonts names "sans", "serif", and "mono"}
}
\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.
+The default settings for \code{width},
+ and \code{height} can be modified from Settings -> Configure RKWard -> Onscreen Graphics.
}
\keyword{devices}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd b/rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
index 9b30a067..7975da03 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
@@ -17,7 +17,8 @@ rk.discard.preview.data(id)
\arguments{
\item{id}{(character). Id associated with the data. Usually this will be the 'id' value of the <preview>-box.}
-\item{value.}{The value to assign. If this is a list, and contains a function named "on.delete", this function
+\item{value.}{The value to assign. If this is a list,
+ and contains a function named "on.delete", this function
will be run by rk.discard.preview.data (with the \code{id} as argument. This is useful for running custom clearnup
code, such as removing temporary files, etc.}
}
@@ -25,8 +26,10 @@ code, such as removing temporary files, etc.}
\code{rk.assign.preview.data} amd \code{rk.get.preview.data} returns the preview data (newly) associated
with the given id. \code{rk.discard.preview.data} returns \code{NULL}, invisibly.
-\bold{Note}: Plugins that want to produce a single plot, or open a single object via \code{\link{rk.edit}()} do \bold{not}
- have to call these functions, manually. See the chapter on providing previews in the Introduction to
+\bold{Note}: Plugins that want to produce a single plot,
+ or open a single object via \code{\link{rk.edit}()} do \bold{not}
+ have to call these functions,
+ manually. See the chapter on providing previews in the Introduction to
writing plugins for RKWard.
}
\description{
@@ -34,8 +37,10 @@ code, such as removing temporary files, etc.}
provided by the <preview>-feature of a plugin.
\code{rk.get.preview.data} retrieves data previously stored with \code{rk.assign.preview.data}
\code{rk.discard.preview.data} discards data previously stored with \code{rk.assign.preview.data}.
- This gets called by the <preview>-box of the plugin, automtically, when the plugin dialog is closed.
- You do not generally have to call it manually. See the notes for running custom clearnup code, below.
+ This gets called by the <preview>-box of the plugin, automtically,
+ when the plugin dialog is closed.
+ You do not generally have to call it manually. See the notes for running custom clearnup code,
+ below.
}
\examples{
## To be generated in the preview() code section of a plugin
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd b/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
index 4e441155..c1dcb3bf 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
@@ -58,7 +58,8 @@ x1 <- rnorm (100)
x2 <- rnorm (100, 2)
rk.call.plugin ("rkward::t_test_two_vars",
- confint.state="1", conflevel.real="0.95", hypothesis.string="greater", paired.state="0", varequal.state="0",
+ confint.state="1", conflevel.real="0.95", hypothesis.string="greater", paired.state="0",
+ varequal.state="0",
x.available="x1", y.available="x2",
submit.mode="submit")
})
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd b/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd
index c023e49b..0ef12175 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd
@@ -10,17 +10,24 @@ rk.embed.device(expr)
\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. Capturing a
- window already "owned" by RKWard (importantly, \code{RK()} device windows) may lead to unexpected results, including crashes.
+\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. Capturing a
+ window already "owned" by RKWard (importantly,
+ \code{RK()} device windows) may lead to unexpected results, including crashes.
}
\examples{
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 e4395f55..e5c46244 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
@@ -39,7 +39,8 @@ This could be scripts or additional CSS definitions, for example. Note that
\item{style}{Currently either "regular" or "preview". The latter omits table of contents and date.}
-\item{css}{Local file name of CSS file to use, or NULL for no CSS file. The CSS file will be
+\item{css}{Local file name of CSS file to use,
+ or NULL for no CSS file. The CSS file will be
placed next to x, with file name extension ".css". Only effective when initializing a
(non-existing) output file.}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd b/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
index 1dc01bf8..dface1bf 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
@@ -13,7 +13,8 @@ rk.graph.on(device.type = getOption("rk.graphics.type"),
rk.graph.off()
}
\arguments{
-\item{device.type}{Type of device to create / graphics format to use. Currently, supported devices are "PNG", "SVG", or "JPG".
+\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.}
@@ -26,11 +27,13 @@ The default is to use the quality configured in Settings -> Configure RKWard ->
\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.}
+\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.
+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}.
}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd b/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
index 06aad83f..b0c621a4 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
@@ -24,15 +24,19 @@ be accessible embedded into other plugins.}
\value{
\code{rk.list.plugins} returns a data.frame listing plugin ids, context, menu path
(tab-separated), and label of the plugin. If a plugin is available in more
- than one context, it will be listed several times. The exact layout (number and order of columns)
- of this data.frame might be subject to change. However, the \bold{names} of the columns in the
+ than one context,
+ it will be listed several times. The exact layout (number and order of columns)
+ of this data.frame might be subject to change. However,
+ the \bold{names} of the columns in the
returned data.frame are expected to remain stable.
\code{rk.set.plugin.status} returns \code{NULL}, invisibly
\bold{Note}: Each call to \code{rk.set.plugin.status} will result in a complete rebuild of the
menu (in the current implementation). While this should be hardly noticeable in interactive
- use, it could be an issue when changing the status of many plugins, programatically.
- In this case, make sure to do all changes in \bold{one} call to \code{rk.set.plugin.status},
+ use, it could be an issue when changing the status of many plugins,
+ programatically.
+ In this case,
+ make sure to do all changes in \bold{one} call to \code{rk.set.plugin.status},
rather than many separate calls.
}
\description{
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd b/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
index 5c6cd94e..34c3390a 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
@@ -15,14 +15,17 @@ if the only desired effect is to reload all active pluginmaps.}
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
+\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.
+\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{
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd b/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
index 0a8e9f58..09dbf097 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.old.packages.Rd
@@ -16,7 +16,8 @@ a character vector of packages which are really 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,
+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.
}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd b/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
index 1423c1b8..1171af6e 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.record.commands.Rd
@@ -9,7 +9,8 @@ rk.record.commands(filename, include.all = FALSE)
\arguments{
\item{filename}{filename to write to (file will be truncated!).}
-\item{include.all}{By default, some types of command are filtered (internal synchronisation commands, and run again links). Should these be included?}
+\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.
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd b/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
index dc18fe91..96b03bd9 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.record.plot.Rd
@@ -40,30 +40,37 @@ rk.duplicate.device(devId = dev.cur())
}
\arguments{
- \item{devId, which}{ an integer, the screen device on which an action is to be performed.}
+ \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.}
+ \item{type}{ a string, either \code{"devices"} or \code{"history"},
+ the type of summary to be printed.}
}
\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.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.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.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.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.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.
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd b/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
index 3648cf85..6982f661 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
@@ -7,7 +7,8 @@
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}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd b/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
index 62005ce4..99c20120 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
@@ -5,6 +5,7 @@
\alias{rk.show.question}
\alias{rk.select.list}
\alias{rk.show.question}
+\alias{rk.askYesNo}
\alias{rk.select.list}
\title{Message boxes and selection list using native KDE GUI}
\usage{
@@ -13,6 +14,9 @@ rk.show.message(message, caption = gettext("Information"), wait = TRUE)
rk.show.question(message, caption = gettext("Question"), button.yes = "yes",
button.no = "no", button.cancel = "cancel", default = TRUE)
+rk.askYesNo(msg, default = TRUE, prompts = c("yes", "no", "cancel"),
+ caption = gettext("Question"), is.rk.askYesNo = TRUE, ...)
+
rk.select.list(list, preselect = NULL, multiple = FALSE, title = NULL)
}
\arguments{
@@ -41,6 +45,18 @@ default value "cancel".}
The corresponding button will focused, so that it will become selected option,
if the user simply presses enter.}
+\item{msg}{like \code{message}, only the argument was renamed to mimic the formals of
+\code{askYesNo}.}
+
+\item{prompts}{either a character vector containing 3 prompts corresponding to return
+values of TRUE, FALSE, or NA, or a single character value containing the prompts
+separated by \code{/} characters.}
+
+\item{is.rk.askYesNo}{a logical value, you can safely ignore this argument if you call
+\code{rk.askYesNo} manually. This argument is needed if \code{rk.askYesNo} is set
+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{list}{a vector, coerced into a character vector.}
\item{multiple}{a logical (not NA), when \code{TRUE} multiple selection
@@ -58,6 +74,9 @@ preselected.}
\bold{No}, and \code{NULL} for \bold{Cancel} actions. If the dialog is closed
without clicking on any button, \code{NULL} is returned, as well.
+\code{rk.askYesNo} has the same return values as \code{rk.show.question}, except
+ it returns \code{NA} for \bold{Cancel} actions.
+
\code{rk.select.list} returns the value of \code{\link{select.list}}.
}
\description{
@@ -84,7 +103,8 @@ if (rk.show.question ("Question:\\nDo you want to know about RKWard?",
button.yes = "Yes, I do!", button.no = "No, I don't care!", button.cancel = "")) {
rk.show.message ("Message:\\nRKWard is a KDE GUI for R.", "RKWard Info")
} else {
- rk.show.message ("You must be joking!", "RKWard Info", wait = FALSE) ## Run asynchronously
+ rk.show.message ("You must be joking!", "RKWard Info",
+ wait = FALSE) ## Run asynchronously
}
## Selection lists:
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.switch.frontend.language.Rd b/rkward/rbackend/rpackages/rkward/man/rk.switch.frontend.language.Rd
index 00c84a94..e6f471ab 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.switch.frontend.language.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.switch.frontend.language.Rd
@@ -13,10 +13,13 @@ rk.switch.frontend.language(LANG = "C")
This feature is mostly intended for the purpose of automated testing, which needs a
defined language to work. It might also be useful for translators, or e.g. to look up
some terms untranslated in special cases where you are more familiar with the English terms than
-your native language terms. Note that this will only strings that are translated after the call., only those which get
-translated after the call. Most new dialogs you open, and importantly new plugin dialogs should
+your native language terms. Note that this will only strings that are translated after the call.,
+ only those which get
+translated after the call. Most new dialogs you open,
+ and importantly new plugin dialogs should
show strings in the new lanuage, however.
}
\details{
-To change the language in the backend, use \code{Sys.setenv(LANGUAGE=...)} or \code{Sys.setlocale()}.
+To change the language in the backend,
+ use \code{Sys.setenv(LANGUAGE=...)} or \code{Sys.setlocale()}.
}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.with.window.hints.Rd b/rkward/rbackend/rpackages/rkward/man/rk.with.window.hints.Rd
index d8b78413..0ec016cc 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.with.window.hints.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.with.window.hints.Rd
@@ -8,18 +8,24 @@
.rk.with.window.hints(expr, placement = "", name = "", style = "")
}
\arguments{
-\item{expr}{Expression to evaluate, unsually an expression that is expected to create exactly one
+\item{expr}{Expression to evaluate,
+ unsually an expression that is expected to create exactly one
new window.}
-\item{placement}{a character string specifying either "attached" or "detached" placement, or
+\item{placement}{a character string specifying either "attached" or "detached" placement,
+ or
(if left empty) the default placement for the type of window created.}
-\item{name}{character string specifing a named position. If a name is given, and this position is
-not yet known, the placement hint (see above) will be followed. If later a second window is
+\item{name}{character string specifing a named position. If a name is given,
+ and this position is
+not yet known,
+ the placement hint (see above) will be followed. If later a second window is
created with the same given name, it will replace the first window.}
-\item{style}{character string specifing a style hint. Currently, this can either be "preview" or
-"" (default), with most types of window not implementing any special behavior for "preview".}
+\item{style}{character string specifing a style hint. Currently,
+ this can either be "preview" or
+"" (default),
+ with most types of window not implementing any special behavior for "preview".}
}
\value{
\code{NULL}, invisibly.
@@ -28,7 +34,8 @@ created with the same given name, it will replace the first window.}
\code{.rk.with.window.hints} can be used to make windows appear in a specific
location: attached, detached, or in a named position where a previous window is
found. (The latter used for preview windows, importantly). It can also be used to pass
-"style" hints, importantly indicating that the window is a preview window. All specifications
+"style" hints,
+ importantly indicating that the window is a preview window. All specifications
affect newly created windows, only, not existing ones.
}
\details{
diff --git a/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd b/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
index 6cb42487..d4186c14 100644
--- a/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
@@ -2,28 +2,36 @@
% Please edit documentation in R/rkward-package.R
\docType{package}
\name{rkward-package}
+\alias{rkward}
\alias{rkward-package}
-\title{The rkward Package}
+\title{\packageTitle{rkward}}
\description{
-Provides functions related to the RKWard GUI.
+\packageDescription{rkward}
}
\details{
+The DESCRIPTION file:
\tabular{ll}{
Package: \tab rkward\cr
Type: \tab Package\cr
-Version: \tab 0.6.3\cr
-Date: \tab 2014-10-30\cr
+Version: \tab 0.7.1\cr
+Date: \tab 2018-05-22\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.kde.org\cr
+URL: \tab https://rkward.kde.org\cr
+}
+}
+\seealso{
+Useful links:
+\itemize{
+ \item \url{https://rkward.kde.org}
+ \item Report bugs at \url{https://rkward.kde.org/Bugs}
}
-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, with contributions from RKWard-devel mailing list
+\packageAuthor{rkward}
+
+Maintainer: \packageMaintainer{rkward}
}
-\keyword{package}
More information about the rkward-tracker
mailing list