[rkward-cvs] SF.net SVN: rkward:[4326] trunk/rkward/rkward/rbackend/rpackages/rkward/R
m-eik at users.sourceforge.net
m-eik at users.sourceforge.net
Sat Sep 29 15:10:02 UTC 2012
Revision: 4326
http://rkward.svn.sourceforge.net/rkward/?rev=4326&view=rev
Author: m-eik
Date: 2012-09-29 15:10:01 +0000 (Sat, 29 Sep 2012)
Log Message:
-----------
added some more roxygen tags to the rkward package, should allow to fully roxygenizing those docs now
Modified Paths:
--------------
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.edit-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.plugin-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.replace.function.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sessionInfo.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sync-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R
trunk/rkward/rkward/rbackend/rpackages/rkward/R/rkward-package.R
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.KDE_GUI-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -67,6 +67,7 @@
# to disable a button, set it to ""
#' @export
+#' @rdname rk.show.messages
"rk.show.question" <- function (message, caption = "Question", button.yes = "yes", button.no = "no", button.cancel = "cancel") {
res <- .Call ("rk.dialog", caption, message, button.yes, button.no, button.cancel, TRUE)
if (res > 0) return (TRUE)
@@ -76,6 +77,7 @@
# drop-in-replacement for tk_select.list()
#' @export
+#' @rdname rk.show.messages
"rk.select.list" <- function (list, preselect = NULL, multiple = FALSE, title = NULL) {
preselect <- as.character (preselect)
preselect.len = length (preselect)
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.edit-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.edit-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.edit-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -44,6 +44,7 @@
}
#' @export
+#' @rdname rk.edit
"rk.edit.files" <- function (file = file, title = file, name = NULL, prompt = TRUE)
{
if (!is.character (file)) {
@@ -59,12 +60,14 @@
}
#' @export
+#' @rdname rk.edit
"rk.show.files" <- function (file = file, title = file, wtitle = NULL, delete=FALSE, prompt = TRUE)
{
invisible (.Call ("rk.show.files", as.character (file), as.character (title), as.character (wtitle), delete, isTRUE (prompt)))
}
#' @export
+#' @rdname rk.edit
"rk.show.html" <- function (url) {
invisible (.rk.do.plain.call ("showHTML", as.character (url), synchronous=FALSE));
}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.filename-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -55,6 +55,7 @@
}
#' @export
+#' @rdname rk.get.tempfile.name
"rk.get.workspace.url" <- function () {
res <- .rk.do.plain.call ("getWorkspaceUrl")
if (length (res)) res
@@ -62,11 +63,13 @@
}
#' @export
+#' @rdname rk.get.tempfile.name
"rk.get.output.html.file" <- function () {
return (.rk.variables$.rk.output.html.file)
}
#' @export
+#' @rdname rk.get.tempfile.name
"rk.set.output.html.file" <- function (x) {
stopifnot (is.character (x))
assign (".rk.output.html.file", x, .rk.variables)
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.label-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -105,6 +105,7 @@
# make a short name from the given arg (a character string)
# e.g. return "b" for a[["b"]] (but 'a::"b"' for a::"b"
#' @export
+#' @rdname rk.label
".rk.make.short.name" <- function (x) {
splt <- strsplit (x, "[[\"", fixed=TRUE)[[1]]
spltlen <- length (splt)
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.plugin-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.plugin-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.plugin-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -71,6 +71,7 @@
}
#' @export
+#' @rdname rk.call.plugin
"rk.call.plugin" <- function (plugin, ..., submit.mode = c ("manual", "auto", "submit")) {
# prepare arguments
settings <- list (...)
@@ -132,6 +133,7 @@
#'
#' ## END NOT RUN
#' @export
+#' @rdname rk.load.pluginmaps
"rk.load.pluginmaps" <- function (pluginmap.files=NULL, force.add = TRUE, force.reload = TRUE) {
.rk.do.plain.call ("loadPluginMaps", c (ifelse (isTRUE (force.add), "force", "noforce"), ifelse (isTRUE (force.reload), "reload", "noreload"), as.character (pluginmap.files)), synchronous=FALSE)
}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.print-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -97,11 +97,13 @@
}
#' @export
+#' @rdname rk.results
"rk.print.code" <- function(code) {
.rk.cat.output (.rk.do.plain.call ("highlightRCode", as.character (code)))
}
#' @export
+#' @rdname rk.results
"rk.header" <- function (title, parameters=list (), level=1, toc=NULL) {
sink (rk.get.output.html.file(), append=TRUE)
on.exit (sink ())
@@ -147,6 +149,7 @@
".rk.date" <- function () date ()
#' @export
+#' @rdname rk.results
"rk.results" <- function (x, titles=NULL, print.rownames) {
sink (rk.get.output.html.file(), append=TRUE)
on.exit (sink ())
@@ -221,6 +224,7 @@
}
#' @export
+#' @rdname rk.results
"rk.print.literal" <- function (x) {
cat ("<pre>", paste (x, collapse="\n"), "</pre>\n", sep="", file=rk.get.output.html.file(), append=TRUE);
}
@@ -228,6 +232,7 @@
# Describe the alternative (H1) of an htest.
# This code adapted from stats:::print.htest
#' @export
+#' @rdname rk.results
"rk.describe.alternative" <- function (x) {
res <- ""
if (!is.null(x$alternative)) {
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.replace.function.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.replace.function.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.replace.function.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -11,10 +11,10 @@
#' several subsequent replacments of the same function, nor does it support
#' replacement of generics.
#'
-#' WARNING: This function can be used to alter - and disrupt - internal
+#' \bold{WARNING}: This function can be used to alter - and disrupt - internal
#' functions in arbitrary ways. You better know what you are doing.
#'
-#' WARNING: Does not work well on generics!
+#' \bold{WARNING}: Does not work well on generics!
#'
#' @param functionname name of the function to be replaced (character).
#' @param environment package environment or namespace, where replacment should
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sessionInfo.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sessionInfo.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sessionInfo.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -13,7 +13,7 @@
#' @seealso \code{\link{sessionInfo}}
#' @keywords utilities misc
#' @export
-#' @rdname rk.sessionInf
+#' @rdname rk.sessionInfo
#' @examples
#'
#' rk.sessionInfo()
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sync-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sync-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.sync-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -34,6 +34,7 @@
# should this really be public?
#' @export
+#' @rdname rk.sync
"rk.sync.global" <- function () {
.rk.do.call("syncglobal", ls (envir=globalenv (), all.names=TRUE))
}
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rk.utility-functions.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -53,6 +53,7 @@
}
#' @export
+#' @rdname rk.misc
"rk.make.repos.string" <- function () {
x <- getOption ("repos")
len <- length (x)
@@ -76,6 +77,7 @@
# a wrapper around chooseCRANmirror() without changing options ("repos"), permanently
#' @export
+#' @rdname rk.misc
"rk.select.CRAN.mirror" <- function () {
old_repos <- getOption("repos")
on.exit (options (repos=old_repos))
@@ -107,7 +109,7 @@
#'
#' @author Thomas Friedrichsmeier \email{rkward-devel@@lists.sourceforge.net}
#' @keywords attribute misc utilities
-#' @rdname rk.misc
+#' @rdname rk.old.packages
#' @examples
#'
#' ## NOT RUN
@@ -135,13 +137,16 @@
}
-# Start recording commands that are submitted from rkward to R.
-# filename: filename to write to (file will be truncated!).
-# include.all: By default, some types of command are filtered (internal synchronisation commands, and run again links). Should these be included?
-# To stop recording, supply NULL or "" as filename
-# Currently used for the purpose of automated testing, only. Perhaps in the future
-# this or a similar mechanism could also be added as a user feature.
+#' Start recording commands that are submitted from RKWard to R
+#'
+#' To stop recording, supply NULL or "" as filename.
+#' Currently used for the purpose of automated testing, only. Perhaps in the future
+#' this or a similar mechanism could also be added as a user feature.
+#'
+#' @param filename filename to write to (file will be truncated!).
+#' @param include.all By default, some types of command are filtered (internal synchronisation commands, and run again links). Should these be included?
#' @export
+#' @rdname rk.record.commands
"rk.record.commands" <- function (filename, include.all = FALSE) {
if (is.null (filename)) filename = ""
Modified: trunk/rkward/rkward/rbackend/rpackages/rkward/R/rkward-package.R
===================================================================
--- trunk/rkward/rkward/rbackend/rpackages/rkward/R/rkward-package.R 2012-09-29 09:11:32 UTC (rev 4325)
+++ trunk/rkward/rkward/rbackend/rpackages/rkward/R/rkward-package.R 2012-09-29 15:10:01 UTC (rev 4326)
@@ -3,8 +3,8 @@
#' \tabular{ll}{
#' Package: \tab rkward\cr
#' Type: \tab Package\cr
-#' Version: \tab 0.5.8\cr
-#' Date: \tab 2012-03-19\cr
+#' Version: \tab 0.6.0\cr
+#' Date: \tab 2012-09-29\cr
#' Depends: \tab R (>= 2.9.0),methods\cr
#' Encoding: \tab UTF-8\cr
#' License: \tab GPL (>= 2)\cr
@@ -19,6 +19,6 @@
#' @name rkward-package
#' @docType package
#' @title Provides functions related to the RKWard GUI.
-#' @author Thomas Friedrichsmeier \email{thomas.friedrichsmeier@@ruhr-uni-bochum.de}, with contributions from the RKWard Team
+#' @author Thomas Friedrichsmeier \email{thomas.friedrichsmeier@@ruhr-uni-bochum.de}, with contributions from RKWard-devel mailing list \email{rkward-devel@@lists.sourceforge.net}
#' @keywords package
NULL
This was sent by the SourceForge.net collaborative development platform, the world's largest Open Source development site.
More information about the rkward-tracker
mailing list