Commit 137d98c8 authored by Thomas Friedrichsmeier's avatar Thomas Friedrichsmeier
Browse files

Roxygenize

parent be95db58
......@@ -41,3 +41,4 @@ Collate:
'rk.workspace-functions.R'
'rkward-package.R'
'ver.R'
RoxygenNote: 5.0.1
# Generated by roxygen2 (4.0.2): do not edit by hand
# Generated by roxygen2: do not edit by hand
export(.onAttach)
export(.rk.app.version)
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/public_graphics.R
\name{RK}
\alias{RK}
\title{Plot graphics to RKWard native device}
......@@ -25,7 +26,7 @@ including the device independent fonts names "sans", "serif", and "mono"}
\item{antialias}{Antialiasing. Can be turned off for somewhat faster drawing.}
}
\description{
\code{RK()} creates an R on-screen device that will be rendered in the RKWard frontend.
\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.
}
\keyword{devices}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.plugin-functions.R
\name{rk.call.plugin}
\alias{rk.call.plugin}
\title{Call built-in RKWard plugin(s)}
......@@ -49,17 +50,19 @@ run in the global context. Any local variables of the calling context are
not available to the plugin.
}
\examples{
## "t_test_two_vars" plugin:
## see the output: Windows->Show Output
local({
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",
x.available="x1", y.available="x2",
rk.call.plugin ("rkward::t_test_two_vars",
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")
})
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.demo.R
\name{rk.demo}
\alias{rk.demo}
\title{Opens an R demo script for editing}
......@@ -22,6 +23,7 @@ script for editing, instead of sourcing it. Contrary to \code{\link{demo}},
the specification of a topic is mandatory.
}
\examples{
## Not run
rk.demo("graphics")
}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.edit-functions.R
\name{rk.edit}
\alias{rk.edit}
\alias{rk.edit.files}
......@@ -53,6 +54,7 @@ by default, when run inside an RKWard session. (via \code{getOption("editor")},
and \code{getOption("browser")}.
}
\examples{
## Not run
x <- data.frame (a=c(1:3), b=c(2:4))
rk.edit(x)
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/public_graphics.R
\name{rk.embed.device}
\alias{rk.embed.device}
\title{Embed non-RKWard device windows}
......@@ -22,9 +23,11 @@ Theoretically, \code{expr} can be any valid R expression. However typically this
window already "owned" by RKWard (importantly, \code{RK()} device windows) may lead to unexpected results, including crashes.
}
\examples{
## Not run:
rk.embed.device (grDevices::X11(title="X11 device window"))
plot (rnorm (10))
}
\seealso{
\link{RK}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.filename-functions.R
\name{rk.get.tempfile.name}
\alias{rk.flush.output}
\alias{rk.get.output.html.file}
......@@ -45,7 +46,7 @@ This could be scripts or additional CSS definitions, for example. Note that
In RKWard the output is saved as a html file which is located at "~/.rkward"
by default. (\bold{TODO}: make this platform free). The name of this html
file can be retrieved and set using \code{rk.get.output.html.file} and
\code{rk.set.output.html.file}. \code{rk.flush.output.html.file} will delete
\code{rk.set.output.html.file}. \code{rk.flush.output.html.file} will delete
the current (or specified) html file, and re-initialize it.
}
\details{
......@@ -63,6 +64,7 @@ is note affected by running \code{load} in R, only by loading R workspaces
via the RKWard GUI.
}
\examples{
testfile.name <- rk.get.tempfile.name(prefix="test", extension=".txt")
testfile <- file(testfile.name)
cat("This is a test\\n", file=testfile)
......@@ -77,6 +79,7 @@ rk.header("Output on a different output file")
rk.show.html(rk.get.output.html.file())
rk.flush.output()
rk.set.output.html.file(outfile)
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/public_graphics.R
\name{rk.graph.on}
\alias{rk.graph.off}
\alias{rk.graph.on}
......@@ -48,6 +49,7 @@ rk.graph.off ()
## WRONG USAGE: not run:
#plot (rnorm (100))
#dev.print (device = rk.graph.on)
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.label-functions.R
\name{rk.get.label}
\alias{.rk.make.short.name}
\alias{rk.get.description}
......@@ -74,6 +75,7 @@ returned by \code{rk.get.description()}. This can be used as a drop-in
replacement for \code{\link{list}}.
}
\examples{
x <- data.frame(a=c(1:3), b=c(2:4))
rk.set.label(x[["a"]], "First column")
rk.get.short.name (x$a) # "x$a"
......@@ -83,6 +85,7 @@ rk.list.labels (x) # "First column" ""
rk.list.labels (x, TRUE) # "First column" "b"
rk.list.names (x, x$a, x$b) # "x" "x$a" "x$b"
names (rk.list (x$a, x$b)) # "x$a (First column)" "x$b"
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.plugin-functions.R
\name{rk.list.plugins}
\alias{rk.list.plugins}
\alias{rk.set.plugin.status}
......@@ -16,8 +17,8 @@ meaning the plugin will be affected in all contexts it occurs in, or a character
of the same length as id.}
\item{visible}{logical, controlling whether the plugin should be shown (\code{TRUE}) or
hidden (\code{FALSE}). Hidden plugins are essentially removed from the menu. They may still
be accessible embedded into other plugins.}
hidden (\code{FALSE}). Hidden plugins are essentially removed from the menu. They may still
be accessible embedded into other plugins.}
}
\value{
\code{rk.list.plugins} returns a data.frame listing plugin ids, context, menu path
......@@ -47,6 +48,7 @@ rk.list.plugins ()
## hide t.test plugin
rk.set.plugin.status ("rkward::t_test", visible=FALSE)
## END NOT RUN
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.plugin-functions.R
\name{rk.load.pluginmaps}
\alias{rk.load.pluginmaps}
\title{(Re-)load the given pluginmap files into the RKWard GUI}
......@@ -28,6 +29,7 @@ priority setting. In scripted usage, this should generally be set to FALSE.}
(Re-)load the given pluginmap files into the RKWard GUI
}
\examples{
## NOT RUN
## reload all active pluginmaps
......@@ -39,9 +41,7 @@ rk.load.pluginmaps()
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
}
\seealso{
\code{\link{rk.call.plugin}},
\code{\link{rkwarddev::rk.plugin.skeleton}}
\code{\link{rk.call.plugin}}, @seealso \code{\link{rkwarddev::rk.plugin.skeleton}}
}
\keyword{utilities}
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.utility-functions.R
\name{rk.rename.in.container}
\alias{rk.make.repos.string}
\alias{rk.misc}
......@@ -45,11 +46,13 @@ permanently. It uses native KDE gui and provides more information on each
mirror.
}
\examples{
## rk.rename.in.container
ir <- iris
str (ir)
rk.rename.in.container(ir, "Species", "Taxonomic.Group")
str (ir)
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.utility-functions.R
\name{rk.old.packages}
\alias{rk.old.packages}
\title{Slightly smarter variant of old.packages()}
......@@ -20,8 +21,10 @@ old.packages() will report package X at B as old. In contrast rk.old.packages()
that the current version is higher up in the path, and not report package X as old.
}
\examples{
## NOT RUN
rk.old.packages()
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/public_graphics.R
\name{rk.printer.device}
\alias{rk.printer.device}
\title{Device for printing using the KDE print dialog}
......@@ -21,9 +22,11 @@ Typically this device is used with \code{\link{dev.print}}, as shown in the
example, below.
}
\examples{
## Not run:
plot (rnorm (10))
dev.print (rk.printer.device)
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.utility-functions.R
\name{rk.record.commands}
\alias{rk.record.commands}
\title{Start recording commands that are submitted from RKWard to R}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.replace.function.R
\name{rk.replace.function}
\alias{rk.replace.function}
\title{Replace a function inside its package environment / namespace}
......@@ -39,6 +40,7 @@ functions in arbitrary ways. You better know what you are doing.
\bold{WARNING}: Does not work well on generics!
}
\examples{
## Not run
rk.replace.function ("history", as.environment ("package:utils"),
function () {
......@@ -46,6 +48,7 @@ rk.replace.function ("history", as.environment ("package:utils"),
eval (body (.rk.backups$history))
})
## End not run
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.print-functions.R
\name{rk.print}
\alias{rk.describe.alternative}
\alias{rk.header}
......@@ -80,6 +81,7 @@ a \code{htest}. This is similar to \code{stats:::print.htext} and makes
sense only when \code{x$alternatives} exists.
}
\examples{
require (rkward)
require (R2HTML)
......@@ -111,6 +113,7 @@ rk.results (list (
'confidence interval percent'=(100 * attr(result$conf.int, "conf.level")),
'confidence interval of difference'=result$conf.int ))
})
}
\author{
Thomas Friedrichsmeier \email{rkward-devel@kde.org}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/internal_graphics.R
\name{rk.screen.device}
\alias{rk.screen.device}
\title{DEPRECATED: \code{rk.screen.device} is obsolete. It simply calls \code{dev.new()} in this version of RKWard.}
......
% Generated by roxygen2 (4.0.2): do not edit by hand
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/rk.sessionInfo.R
\name{rk.sessionInfo}
\alias{rk.sessionInfo}
\title{Print information on the RKWard session}
......@@ -19,6 +20,7 @@ Typically, when reporting a bug, you should use \code{Help->Report Bug...}
from the menu. Internally, this will call \code{rk.sessionInfo()}.
}
\examples{
rk.sessionInfo()
}
\author{
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment