[education/rkward] rkward/rbackend/rpackages/rkward: updated the docs
m.eik michalke
null at kde.org
Thu Jul 11 21:04:26 BST 2024
Git commit cd8f740847fcd9d431d194774a7294e839d7dd8e by m.eik michalke.
Committed on 11/07/2024 at 20:01.
Pushed by meikm into branch 'master'.
updated the docs
M +10 -9 rkward/rbackend/rpackages/rkward/DESCRIPTION
M +10 -2 rkward/rbackend/rpackages/rkward/R/rkward-package.R
M +11 -5 rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
M +11 -1 rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
M +3 -0 rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
M +2 -2 rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
https://invent.kde.org/education/rkward/-/commit/cd8f740847fcd9d431d194774a7294e839d7dd8e
diff --git a/rkward/rbackend/rpackages/rkward/DESCRIPTION b/rkward/rbackend/rpackages/rkward/DESCRIPTION
index 0c6c8eec7..d195ef734 100755
--- a/rkward/rbackend/rpackages/rkward/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkward/DESCRIPTION
@@ -1,11 +1,12 @@
Package: rkward
Type: Package
-Title: RKWard GUI support package
+Title: Provides functions related to the RKWard GUI
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, RKWard Team
+ combination with the RKWard GUI. Many of these functions are
+ only needed for the internal communication between RKWard and
+ R, but some are also useful in user scripts.
+Author: Thomas Friedrichsmeier <thomas.friedrichsmeier at kdemail.net> 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
Suggests: Cairo,googleVis,htmlwidgets,lattice,R2HTML
@@ -15,12 +16,12 @@ License: GPL (>= 2)
Encoding: UTF-8
LazyLoad: yes
Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
- email="thomas.friedrichsmeier at kdemail.net",
- role=c("aut")), person(family="the RKWard team",
+ email="thomas.friedrichsmeier at kdemail.net", role=c("aut")),
+ person(given="the RKWard", family="team",
email="rkward-devel at kde.org", role=c("cre","aut")))
Version: 0.8.0
-Date: 2024-07-07
-RoxygenNote: 7.2.2
+Date: 2024-07-11
+RoxygenNote: 7.3.1
Collate:
'base_overrides.R'
'internal.R'
diff --git a/rkward/rbackend/rpackages/rkward/R/rkward-package.R b/rkward/rbackend/rpackages/rkward/R/rkward-package.R
index 615cd1f72..e0103a470 100644
--- a/rkward/rbackend/rpackages/rkward/R/rkward-package.R
+++ b/rkward/rbackend/rpackages/rkward/R/rkward-package.R
@@ -2,14 +2,18 @@
# SPDX-FileCopyrightText: by Thomas Friedrichsmeier <thomas.friedrichsmeier at kdemail.net>
# SPDX-FileContributor: The RKWard Team <rkward-devel at kde.org>
# SPDX-License-Identifier: GPL-2.0-or-later
+# This file was generated by roxyPackage::roxy.package()
+# and will likely be overwritten on its next run.
+# Editing is futile.
+
#' \packageDescription{rkward}
#'
#' The DESCRIPTION file:
#' \tabular{ll}{
#' Package: \tab rkward\cr
#' Type: \tab Package\cr
-#' Version: \tab 0.7.1\cr
-#' Date: \tab 2018-10-11\cr
+#' Version: \tab 0.8.0\cr
+#' Date: \tab 2024-07-11\cr
#' Depends: \tab R (>= 2.9.0),methods\cr
#' Encoding: \tab UTF-8\cr
#' License: \tab GPL (>= 2)\cr
@@ -24,3 +28,7 @@
#'
#' Maintainer: \packageMaintainer{rkward}
"_PACKAGE"
+
+## usethis namespace: start
+## usethis namespace: end
+NULL
diff --git a/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd b/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
index e2c402eba..6eee8e0cb 100644
--- a/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/DeviceOverrides.Rd
@@ -47,13 +47,19 @@ x11(
windows(
width = getOption("rk.screendevice.width"),
height = getOption("rk.screendevice.height"),
- pointsize = 12
+ pointsize = 12,
+ bg,
+ title,
+ antialias
)
win.graph(
width = getOption("rk.screendevice.width"),
height = getOption("rk.screendevice.height"),
- pointsize = 12
+ pointsize = 12,
+ bg,
+ title,
+ antialias
)
quartz(
@@ -84,8 +90,8 @@ quartz(
\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
+ Colours in R are \abbr{sRGB}; if your monitor does not conform to
+ \abbr{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).}
@@ -117,7 +123,7 @@ quartz(
\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
+ \code{file} argument of \code{\link{df}} for further
details). How non-ASCII titles are handled is
implementation-dependent.}
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd b/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
index 392c02454..7a3352333 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.edit.Rd
@@ -5,6 +5,7 @@
\alias{rk.edit.files}
\alias{rk.show.files}
\alias{rk.show.html}
+\alias{rk.show.pdf}
\title{Edit / show an object / file}
\usage{
rk.edit(x)
@@ -20,7 +21,9 @@ rk.show.files(
delete = delete.file
)
-rk.show.html(url)
+rk.show.html(url, content)
+
+rk.show.pdf(url)
}
\arguments{
\item{x}{an object to edit.}
@@ -63,6 +66,13 @@ recommended to use \link{edit}, \link{file.edit}, \link{file.show},
and \link{browseURL}, instead. These will call the respective RKWard functions
by default, when run inside an RKWard session. (via \code{getOption("editor")},
and \code{getOption("browser")}.
+
+\code{rk.show.html} with \code{content}-argument, insed of \code{url}-argument, will
+show the given HTML string. This is mostly useful for plugins, where it may be
+desirable to show an error-message at the place where usually an HTML-file would
+be shown.
+
+\code{rk.show.pdf} opens a PDF (or postscript) document in a viewer window inside RKWard.
}
\examples{
\dontrun{
diff --git a/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd b/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
index a273f10bf..7b77e83d5 100644
--- a/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rk.sessionInfo.Rd
@@ -18,6 +18,9 @@ in RKWard.
\details{
Typically, when reporting a bug, you should use \code{Help->Report Bug...}
from the menu. Internally, this will call \code{rk.sessionInfo()}.
+
+The returned information is untranslated, deliberately, as it is meant for
+pasting into the bug tracker.
}
\examples{
\dontrun{
diff --git a/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd b/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
index 7bb1b4eea..32ce866f9 100644
--- a/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/rkward-package.Rd
@@ -13,8 +13,8 @@ The DESCRIPTION file:
\tabular{ll}{
Package: \tab rkward\cr
Type: \tab Package\cr
-Version: \tab 0.7.1\cr
-Date: \tab 2018-10-11\cr
+Version: \tab 0.8.0\cr
+Date: \tab 2024-07-11\cr
Depends: \tab R (>= 2.9.0),methods\cr
Encoding: \tab UTF-8\cr
License: \tab GPL (>= 2)\cr
More information about the rkward-tracker
mailing list