[rkward] rkward/rbackend/rpackages/rkward: updated docs of rkward package via roxygen
m.eik michalke
null at kde.org
Thu Oct 11 10:23:05 BST 2018
Git commit 0cc77deedd77fb18436ed2ef6d918c44ff9083e8 by m.eik michalke.
Committed on 11/10/2018 at 09:22.
Pushed by meikm into branch 'master'.
updated docs of rkward package via roxygen
M +5 -7 rkward/rbackend/rpackages/rkward/DESCRIPTION
M +1 -1 rkward/rbackend/rpackages/rkward/R/rkward-package.R
M +4 -2 rkward/rbackend/rpackages/rkward/man/RKdevice.Rd
M +10 -6 rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.call.plugin.Rd
M +8 -4 rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
M +0 -3 rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
M +14 -7 rkward/rbackend/rpackages/rkward/man/rk.embed.device.Rd
M +4 -6 rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
M +6 -6 rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
M +0 -5 rkward/rbackend/rpackages/rkward/man/rk.label.Rd
M +8 -5 rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
M +6 -3 rkward/rbackend/rpackages/rkward/man/rk.load.pluginmaps.Rd
M +0 -2 rkward/rbackend/rpackages/rkward/man/rk.misc.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 +0 -5 rkward/rbackend/rpackages/rkward/man/rk.results.Rd
M +2 -1 rkward/rbackend/rpackages/rkward/man/rk.screen.device.Rd
M +7 -6 rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
M +6 -3 rkward/rbackend/rpackages/rkward/man/rk.switch.frontend.language.Rd
M +0 -1 rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
M +14 -7 rkward/rbackend/rpackages/rkward/man/rk.with.window.hints.Rd
M +0 -1 rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
M +1 -2 rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
https://commits.kde.org/rkward/0cc77deedd77fb18436ed2ef6d918c44ff9083e8
diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index 3bdf2093..89b1f4ff 100755
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -5,23 +5,20 @@ 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>
+Author: Thomas Friedrichsmeier and the RKWard Team
Maintainer: RKWard-devel mailing list <rkward-devel at kde.org>
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
Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
email="thomas.friedrichsmeier at ruhr-uni-bochum.de",
- role=c("aut")), person(given="the RKWard", family="team",
+ role=c("aut")), person(given="the RKWard team",
email="rkward-devel at kde.org", role=c("cre","ctb")))
Version: 0.7.1
-Date: 2018-05-22
-RoxygenNote: 6.0.1
+Date: 2018-10-11
+RoxygenNote: 6.1.0
Collate:
'base_overrides.R'
'internal.R'
@@ -30,6 +27,7 @@ Collate:
'internal_help.R'
'public_graphics.R'
'rk.KDE_GUI-functions.R'
+ 'rk.check_for_pandoc.R'
'rk.demo.R'
'rk.edit-functions.R'
'rk.filename-functions.R'
diff --git a/rkward/rbackend/rpackages/rkward/R/rkward-package.R b/rkward/rbackend/rpackages/rkward/R/rkward-package.R
index cb1bf585..4b3a7edd 100644
--- a/rkward/rbackend/rpackages/rkward/R/rkward-package.R
+++ b/rkward/rbackend/rpackages/rkward/R/rkward-package.R
@@ -5,7 +5,7 @@
#' Package: \tab rkward\cr
#' Type: \tab Package\cr
#' Version: \tab 0.7.1\cr
-#' Date: \tab 2018-05-22\cr
+#' Date: \tab 2018-10-11\cr
#' Depends: \tab R (>= 2.9.0),methods\cr
#' Encoding: \tab UTF-8\cr
#' License: \tab GPL (>= 2)\cr
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..04907039 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.assign.preview.data.Rd
@@ -4,7 +4,6 @@
\alias{rk.assign.preview.data}
\alias{rk.get.preview.data}
\alias{.rk.discard.preview.data}
-\alias{rk.get.preview.data}
\alias{rk.discard.preview.data}
\title{Manage (shortly) persistent data for previews (for use in RKWard plugins wishing to provide custom previews)}
\usage{
@@ -17,7 +16,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 +25,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 +36,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.capture.output.Rd b/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
index 96f31313..a45e6663 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.capture.output.Rd
@@ -15,15 +15,19 @@ rk.end.capture.output(highlight = FALSE)
}
\description{
This feature records and / or redirects output similar to the \code{\link{sink}} and \code{\link{capture.output}}
-commands provided with R. Contrary to these two, \code{rk.capture.output} can also capture output generated by external
+commands provided with R. Contrary to these two,
+ \code{rk.capture.output} can also capture output generated by external
programs running via \code{\link{system}} (on both Windows and Unix platforms). Further it allows to capture both
-warning messages and regular output to the same channel. Output can be passed on for printing, or suppressed,
+warning messages and regular output to the same channel. Output can be passed on for printing,
+ or suppressed,
with the default being to print it.
}
\details{
-And arbitrary number of ouptut captures can be started and stopped, and these will form a push/pop stack.
+And arbitrary number of ouptut captures can be started and stopped,
+ and these will form a push/pop stack.
\code{rk.capture.output} Starts capturing output.
-\code{rk.end.capture.output} Stops capturing output, and returns the recorded output in a string.
+\code{rk.end.capture.output} Stops capturing output,
+ and returns the recorded output in a string.
}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd b/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
index e4854b70..7b10efbb 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
@@ -5,9 +5,6 @@
\alias{rk.edit.files}
\alias{rk.show.files}
\alias{rk.show.html}
-\alias{rk.edit.files}
-\alias{rk.show.files}
-\alias{rk.show.html}
\title{Edit / show an object / file}
\usage{
rk.edit(x)
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 75e1014a..f2a6dcc8 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.get.tempfile.name.Rd
@@ -5,9 +5,6 @@
\alias{rk.get.workspace.url}
\alias{rk.get.output.html.file}
\alias{rk.set.output.html.file}
-\alias{rk.get.workspace.url}
-\alias{rk.get.output.html.file}
-\alias{rk.set.output.html.file}
\alias{rk.flush.output}
\title{RKWard file names}
\usage{
@@ -19,8 +16,8 @@ rk.get.output.html.file()
rk.set.output.html.file(x,
additional.header.contents = getOption("rk.html.header.additions"),
- style = c("regular", "preview"), css = getOption("rk.output.css.file"),
- silent = FALSE)
+ style = c("regular", "preview"),
+ css = getOption("rk.output.css.file"), silent = FALSE)
rk.flush.output(x = rk.get.output.html.file(), flush.images = TRUE,
ask = TRUE, ...)
@@ -40,7 +37,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..de879a07 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.graph.on.Rd
@@ -3,7 +3,6 @@
\name{rk.graph.on}
\alias{rk.graph.on}
\alias{rk.graph.off}
-\alias{rk.graph.off}
\title{Plot graphics to HTML output file}
\usage{
rk.graph.on(device.type = getOption("rk.graphics.type"),
@@ -13,7 +12,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,13 +26,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.
-
-\code{rk.graph.off()} closes the device that was opened by \code{rk.graph.on}.
+The default settings for \code{device.type}, \code{width}, \code{height},
+ and \code{quality} can be modified from Settings -> Configure RKWard -> Output.
}
\examples{
require (rkward)
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.label.Rd b/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
index 37bf459a..46166e1e 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.label.Rd
@@ -7,13 +7,8 @@
\alias{rk.get.description}
\alias{rk.list.names}
\alias{rk.list}
-\alias{rk.set.label}
\alias{rk.list.labels}
-\alias{rk.get.short.name}
\alias{.rk.make.short.name}
-\alias{rk.get.description}
-\alias{rk.list}
-\alias{rk.list.names}
\title{Various label related utility functions}
\usage{
rk.get.label(x)
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd b/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
index 06aad83f..b499b0b3 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.list.plugins.Rd
@@ -3,7 +3,6 @@
\name{rk.list.plugins}
\alias{rk.list.plugins}
\alias{rk.set.plugin.status}
-\alias{rk.set.plugin.status}
\title{List of modify loaded plugins}
\usage{
rk.list.plugins()
@@ -24,15 +23,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.misc.Rd b/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
index 22bef6f1..eb5abdfe 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.misc.Rd
@@ -5,8 +5,6 @@
\alias{rk.misc}
\alias{rk.make.repos.string}
\alias{rk.select.CRAN.mirror}
-\alias{rk.make.repos.string}
-\alias{rk.select.CRAN.mirror}
\title{Miscellaneous utility functions}
\usage{
rk.rename.in.container(x, old_name, new_name, envir = parent.frame())
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.results.Rd b/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
index 1847b9c8..89ddf00e 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.results.Rd
@@ -7,11 +7,6 @@
\alias{rk.header}
\alias{rk.results}
\alias{rk.describe.alternative}
-\alias{rk.print.code}
-\alias{rk.header}
-\alias{rk.results}
-\alias{rk.print.literal}
-\alias{rk.describe.alternative}
\title{Print objects and results to output}
\usage{
rk.print(x, ...)
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 dfe3b036..7099a9a5 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.show.messages.Rd
@@ -4,20 +4,20 @@
\alias{rk.show.message}
\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{
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.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)
+rk.select.list(list, preselect = NULL, multiple = FALSE,
+ title = NULL)
}
\arguments{
\item{message}{a string for the content of the message box.}
@@ -103,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.sync.Rd b/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
index b6576f0e..50ecfc8c 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.sync.Rd
@@ -3,7 +3,6 @@
\name{rk.sync}
\alias{rk.sync}
\alias{rk.sync.global}
-\alias{rk.sync.global}
\title{Sync R object(s)}
\usage{
rk.sync(x)
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/rk.workplace.Rd b/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
index a136a363..b9fe9924 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.workplace.Rd
@@ -3,7 +3,6 @@
\name{rk.save.workplace}
\alias{rk.save.workplace}
\alias{rk.restore.workplace}
-\alias{rk.restore.workplace}
\title{Save or restore RKWard workplace}
\usage{
rk.save.workplace(file = NULL, description = NULL)
diff --git a/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd b/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
index d4186c14..9336a2cf 100644
--- a/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
@@ -14,7 +14,7 @@ The DESCRIPTION file:
Package: \tab rkward\cr
Type: \tab Package\cr
Version: \tab 0.7.1\cr
-Date: \tab 2018-05-22\cr
+Date: \tab 2018-10-11\cr
Depends: \tab R (>= 2.9.0),methods\cr
Encoding: \tab UTF-8\cr
License: \tab GPL (>= 2)\cr
@@ -26,7 +26,6 @@ URL: \tab https://rkward.kde.org\cr
Useful links:
\itemize{
\item \url{https://rkward.kde.org}
- \item Report bugs at \url{https://rkward.kde.org/Bugs}
}
}
More information about the rkward-tracker
mailing list