[education/rkward/devel/workspace_output] /: Enable roxygen for rkwardtest, and update.

Thomas Friedrichsmeier null at kde.org
Sat Nov 7 08:58:42 GMT 2020 

Git commit 62e3d650b575c35f4d091ddeac9767701340d47a by Thomas Friedrichsmeier.
Committed on 07/11/2020 at 08:58.
Pushed by tfry into branch 'devel/workspace_output'.

Enable roxygen for rkwardtest, and update.

M  +7    -9    rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
M  +4    -2    rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
M  +9    -5    rkward/rbackend/rpackages/rkwardtests/NAMESPACE
M  +8    -11   rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R
M  +8    -11   rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R
M  +6    -9    rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R
M  +1    -1    rkward/rbackend/rpackages/rkwardtests/R/rktest.getTempDir.R
M  +1    -0    rkward/rbackend/rpackages/rkwardtests/R/rktest.makeplugintests.R
M  +1    -0    rkward/rbackend/rpackages/rkwardtests/R/rktest.replaceRunAgainLink.R
M  +1    -0    rkward/rbackend/rpackages/rkwardtests/R/rktest.runRKTestSuite.R
M  +1    -0    rkward/rbackend/rpackages/rkwardtests/R/rktest.setSuiteStandards.R
M  +1    -0    rkward/rbackend/rpackages/rkwardtests/R/rkwardtests-package.R
D  +0    -10   rkward/rbackend/rpackages/rkwardtests/man/RKTest-class.Rd
A  +31   -0    rkward/rbackend/rpackages/rkwardtests/man/RKTest.Rd
D  +0    -11   rkward/rbackend/rpackages/rkwardtests/man/RKTestResult-class.Rd
A  +31   -0    rkward/rbackend/rpackages/rkwardtests/man/RKTestResult.Rd
D  +0    -11   rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite-class.Rd
A  +27   -0    rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite.Rd
A  +36   -0    rkward/rbackend/rpackages/rkwardtests/man/rktest.expectError.Rd
M  +11   -12   rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd
M  +16   -29   rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd
M  +16   -21   rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd
M  +13   -21   rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd
M  +16   -23   rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
M  +17   -12   rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
M  +10   -8    rkward/rbackend/rpackages/rkwardtests/man/show.Rd
M  +1    -3    scripts/roxygenize.sh

https://invent.kde.org/education/rkward/commit/62e3d650b575c35f4d091ddeac9767701340d47a

diff --git a/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd b/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
index 257ba769..b117894d 100644
--- a/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
+++ b/rkward/rbackend/rpackages/rkward/man/RK.Output.Rd
@@ -14,8 +14,8 @@ rk.output(filename = NULL, create = FALSE, all = FALSE)
 back, to.}
 
 \item{create}{If \code{TRUE}, create a new output directory. The parameter \code{filename}, if specified, is the target save file/directory, in this case. Should this already exist,
-an error will be raised. If \code{FALSE}, load or re-use an existing output directory. If the parameter \code{filename} is left \code{NULL}, \code{rk.output} will
-return the currently active output.}
+an error will be raised. If \code{create=FALSE}, load or re-use an existing output directory. If the parameter \code{filename} is left \code{NULL}, \code{rk.output} will
+return the currently active output in this case (creating and/or activating an output file, in case all outputs have been closed or deactivated).}
 
 \item{all}{If \code{TRUE}, return a list of all currently loaded output directories.}
 
@@ -24,14 +24,12 @@ to overwrite/discard existing files/modifications will result in an error. If \c
 
 \item{discard}{See \code{overwrite} for the meaning.}
 
-\item{ask}{Prompt the user for confirmation before potentially desctrucitve operations such as closing or reverting a modified output.}
-
 \item{raise}{Raise the output window, if it is already visble.}
 }
 \description{
 Since version 0.7.5, RKWard supports more than one piece of output. While dealing with only a single output page, there will be no need for the user to call any of
-             these functions, directly, as exactly one output
-             is always opened for writing in RKWard. However, these functions allow to manage several distinct output pages, programmatically.
+             these functions, directly, as exactly one output is always opened for writing in RKWard (unless rk.set.output.html.file() has been called, explicitly).
+             However, these functions allow to manage several distinct output pages, programmatically.
 
              The primary entry point is the function \code{rk.output}, which allows to retrieve the current output directly, or to load or create a new one. This will return
              an instance of the \code{RK.Output} reference class, which has methods for subsequent manipulation. Two instances of this class may be pointing to the same
@@ -42,7 +40,7 @@ Since version 0.7.5, RKWard supports more than one piece of output. While dealin
              At the time of this writing, output is stored in directories containing an HTML index file, and, usually, several image files, and possibly more.
              However other types of output may be supported in the future, and therefore assumptions about the details of the output storage should be avoided.
 
-             \code{rk.output} can be used to create or load output files, as well as to obtain a reference an already loaded output file. After that, use the class methods
+             \code{rk.output} can be used to create or load output files, as well as to obtain a reference to an already loaded output file. After that, use the class methods
              to operate on the reference obtained.
 }
 \section{Fields}{
@@ -56,7 +54,7 @@ Since version 0.7.5, RKWard supports more than one piece of output. While dealin
 \describe{
 \item{\code{activate()}}{Set this output as the one that rk.print and other RKWard Output functions will write to.}
 
-\item{\code{clear(ask = TRUE)}}{Clear all content from this output. As with any function in this class, this affects the working copy, only, until you call save. Therefore, by default, the user will be prompted for confirmation
+\item{\code{clear(discard = NULL)}}{Clear all content from this output. As with any function in this class, this affects the working copy, only, until you call save. Therefore, by default, the user will be prompted for confirmation
 if and only if there are unsaved changes pending.}
 
 \item{\code{close(discard = NULL)}}{Forget about this output file, also closing any open views. Note: Trying to call any further methods on this object will fail.}
@@ -71,7 +69,7 @@ Do not write anything to the target filename, directly! This is purely for infor
 
 \item{\code{isModified()}}{Returns TRUE, if this output has any changes that may need saving.}
 
-\item{\code{revert(ask = TRUE)}}{Revert this output to the last saved state. If no previous state is available (never saved, before), clears the output.}
+\item{\code{revert(discard = NULL)}}{Revert this output to the last saved state. If no previous state is available (never saved, before), clears the output.}
 
 \item{\code{save(filename, overwrite = NULL)}}{Save this output, either to the last known save location (if no filename is specified) or to a new location ("save as").}
 
diff --git a/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION b/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
index cc0f63af..cccd1721 100644
--- a/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
+++ b/rkward/rbackend/rpackages/rkwardtests/DESCRIPTION
@@ -16,8 +16,8 @@ Authors at R: c(person(given="Thomas", family="Friedrichsmeier",
     email="thomas.friedrichsmeier at ruhr-uni-bochum.de", role=c("aut", "cre")),
     person(given="Meik", family="Michalke", email="meik.michalke at hhu.de",
     role=c("aut", "cre")))
-Version: 0.6.1
-Date: 2012-09-28
+Version: 0.7.2
+Date: 2020-11-07
 Collate:
     'RKTest-class.R'
     'rktest.getTempDir.R'
@@ -25,8 +25,10 @@ Collate:
     'rktest.replaceRunAgainLink.R'
     'RKTestResult-class.R'
     'rktest.runRKTestSuite.R'
+    'rktest.expectError.R'
     'rktest.setSuiteStandards.R'
     'RKTestSuite-class.R'
     'rkwardtests-internal.R'
     'rkwardtests-package.R'
     'show-method.R'
+RoxygenNote: 7.1.1
diff --git a/rkward/rbackend/rpackages/rkwardtests/NAMESPACE b/rkward/rbackend/rpackages/rkwardtests/NAMESPACE
index 4320b308..0ffd92c2 100644
--- a/rkward/rbackend/rpackages/rkwardtests/NAMESPACE
+++ b/rkward/rbackend/rpackages/rkwardtests/NAMESPACE
@@ -1,11 +1,15 @@
-exportClasses(RKTest)
-exportClasses(RKTestResult)
-exportClasses(RKTestSuite)
-exportMethods(show)
+# Generated by roxygen2: do not edit by hand
+
+export(.rktest.tmp.storage)
+export(rktest.commandFailed)
+export(rktest.expectError)
 export(rktest.getTempDir)
 export(rktest.makeplugintests)
 export(rktest.replaceRunAgainLink)
 export(rktest.runRKTestSuite)
 export(rktest.setSuiteStandards)
-export(.rktest.tmp.storage)
+exportClasses(RKTest)
+exportClasses(RKTestResult)
+exportClasses(RKTestSuite)
+exportMethods(show)
 import(methods)
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R b/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R
index c13f70d9..5c6b8d55 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/RKTest-class.R
@@ -1,18 +1,15 @@
-## temporarily turned off most of the roxygen comments
-## class docs will remain static until roxygen2 supports "@slot"
-
 #' S4 class RKTest
 #' 
+#' @description
 #' This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
 #'
-#' @noRd
-# @slot id A unique character string
-# @slot call A function to be called
-# @slot fuzzy_output Allow fuzzy results
-# @slot expect_error Expect errors
-# @slot libraries A charcter vector naming needed libraries
-# @slot files A character vector naming needed files, path relative to the test standards directory
-# @slot record.all.commands Should synchronization commands and commands to generate run-again-links be included in the command recording? Generally, this should be FALSE (the default).
+#' @slot id A unique character string
+#' @slot call A function to be called
+#' @slot fuzzy_output Allow fuzzy results
+#' @slot expect_error Expect errors
+#' @slot libraries A charcter vector naming needed libraries
+#' @slot files A character vector naming needed files, path relative to the test standards directory
+#' @slot record.all.commands Should synchronization commands and commands to generate run-again-links be included in the command recording? Generally, this should be FALSE (the default).
 #' @name RKTest
 #' @import methods
 #' @keywords classes
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R b/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R
index b5d2eaf9..31ebd050 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/RKTestResult-class.R
@@ -1,18 +1,15 @@
-## temporarily turned off most of the roxygen comments
-## class docs will remain static until roxygen2 supports "@slot"
-
 #' S4 Class RKTestResult
 #'
+#' @description
 #' This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
 #'
-#' @noRd
-# @slot id A unique character string naming a test.
-# @slot code_match A character string indicating whether the run code matched the standard.
-# @slot output_match A character string indicating whether the resulting output matched the standard.
-# @slot message_match A character string indicating whether the resulting R messages matched the standard.
-# @slot error A character string indicating errors.
-# @slot missing_libs A character string indicating missing libraries.
-# @slot passed Logical: Did the test pass?
+#' @slot id A unique character string naming a test.
+#' @slot code_match A character string indicating whether the run code matched the standard.
+#' @slot output_match A character string indicating whether the resulting output matched the standard.
+#' @slot message_match A character string indicating whether the resulting R messages matched the standard.
+#' @slot error A character string indicating errors.
+#' @slot missing_libs A character string indicating missing libraries.
+#' @slot passed Logical: Did the test pass?
 #' @name RKTestResult
 #' @import methods
 #' @keywords classes
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R b/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R
index 4849b778..13b7d161 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/RKTestSuite-class.R
@@ -1,16 +1,13 @@
-## temporarily turned off most of the roxygen comments
-## class docs will remain static until roxygen2 supports "@slot"
-
 #' S4 Class RKTestSuite
 #'
+#' @description
 #' This class is used to create test suite objects that can be fed to \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
 #'
-#' @noRd
-# @slot id A unique character string to identify a test suite
-# @slot libraries A charcter vector naming libraries that the test suite depends on.
-# @slot initCalls A list of functions to be run before any tests, e.g. to load libraries or data objects.
-# @slot tests A list of the actual plugin tests.
-# @slot postCalls  A list of functions to be run after all tests, e.g. to clean up.
+#' @slot id A unique character string to identify a test suite
+#' @slot libraries A charcter vector naming libraries that the test suite depends on.
+#' @slot initCalls A list of functions to be run before any tests, e.g. to load libraries or data objects.
+#' @slot tests A list of the actual plugin tests.
+#' @slot postCalls  A list of functions to be run after all tests, e.g. to clean up.
 #' @name RKTestSuite
 #' @import methods
 #' @keywords classes
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/rktest.getTempDir.R b/rkward/rbackend/rpackages/rkwardtests/R/rktest.getTempDir.R
index 5dce8745..269bdb9b 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/rktest.getTempDir.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/rktest.getTempDir.R
@@ -1,5 +1,6 @@
 #' Get the path to the recent temporary directory, if one exists.
 #'
+#' @description
 #' This function will return either the local path to the temporary directory where
 #' all test results have been saved to, or FALSE if none exitsts.
 #' 
@@ -13,7 +14,6 @@
 #' @export
 #' @examples
 #' rktest.getTempDir()
-
 rktest.getTempDir <- function(){
   if(exists(".rktest.temp.dir", where=.rktest.tmp.storage)){
     temp.dir <- get(".rktest.temp.dir", pos=.rktest.tmp.storage)
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/rktest.makeplugintests.R b/rkward/rbackend/rpackages/rkwardtests/R/rktest.makeplugintests.R
index 873964ce..7a20e0a6 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/rktest.makeplugintests.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/rktest.makeplugintests.R
@@ -1,5 +1,6 @@
 #' Run a whole RKWard plugin test suite
 #'
+#' @description
 #' The function \code{rktest.makeplugintests} will run a whole test suite that was prepared to check one or several RKWard plugins.
 #' 
 #' @title Run RKWard plugin test suite
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/rktest.replaceRunAgainLink.R b/rkward/rbackend/rpackages/rkwardtests/R/rktest.replaceRunAgainLink.R
index ef77e3b5..d0182a60 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/rktest.replaceRunAgainLink.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/rktest.replaceRunAgainLink.R
@@ -1,5 +1,6 @@
 #' Replace "Run again" link in RKWard with code
 #'
+#' @description
 #' You can use this to temporarily replace .rk.rerun.plugin.link (see example below).
 #' This way, after running a plugin, you are shown the call needed to run this
 #' plugin with those settings, instead of the link.
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/rktest.runRKTestSuite.R b/rkward/rbackend/rpackages/rkwardtests/R/rktest.runRKTestSuite.R
index 69e33403..b9a9c4f4 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/rktest.runRKTestSuite.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/rktest.runRKTestSuite.R
@@ -1,5 +1,6 @@
 #' Run a single RKWard plugin test suite
 #'
+#' @description
 #' This function can be called to run a single plugin test suite.
 #' 
 #' @title Run RKWard plugin test suite
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/rktest.setSuiteStandards.R b/rkward/rbackend/rpackages/rkwardtests/R/rktest.setSuiteStandards.R
index 5f4da646..acb34ca1 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/rktest.setSuiteStandards.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/rktest.setSuiteStandards.R
@@ -1,5 +1,6 @@
 #' Set RKWard plugin test suite standards
 #'
+#' @description
 #' Use this function after you plugin passed all tests to set the resulting code,
 #' output and R messages as the standard that will be compared to during following tests.
 #' 
diff --git a/rkward/rbackend/rpackages/rkwardtests/R/rkwardtests-package.R b/rkward/rbackend/rpackages/rkwardtests/R/rkwardtests-package.R
index 8ceef2cd..0b722813 100644
--- a/rkward/rbackend/rpackages/rkwardtests/R/rkwardtests-package.R
+++ b/rkward/rbackend/rpackages/rkwardtests/R/rkwardtests-package.R
@@ -12,6 +12,7 @@
 #' URL: \tab http://rkward.kde.org\cr
 #' }
 #'
+#' @description
 #' A set of functions, classes and methods to test plugins that were written for RKWard.
 #'
 #' @aliases rkwardtests-package rkwardtests
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/RKTest-class.Rd b/rkward/rbackend/rpackages/rkwardtests/man/RKTest-class.Rd
deleted file mode 100644
index 9b7089f1..00000000
--- a/rkward/rbackend/rpackages/rkwardtests/man/RKTest-class.Rd
+++ /dev/null
@@ -1,10 +0,0 @@
-\name{RKTest-class}
-\alias{RKTest
--class}
-\alias{RKTest}
-\title{S4 class RKTest}
-\description{This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.}
-\keyword{classes}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}}
-\section{Slots}{\describe{\item{\code{id}:}{}\item{\code{call}:}{}\item{\code{fuzzy_output}:}{}\item{\code{expect_error}:}{}\item{\code{libraries}:}{}\item{\code{files}:}{}}}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/RKTest.Rd b/rkward/rbackend/rpackages/rkwardtests/man/RKTest.Rd
new file mode 100644
index 00000000..8e39b792
--- /dev/null
+++ b/rkward/rbackend/rpackages/rkwardtests/man/RKTest.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/RKTest-class.R
+\docType{class}
+\name{RKTest}
+\alias{RKTest}
+\title{S4 class RKTest}
+\description{
+This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{id}}{A unique character string}
+
+\item{\code{call}}{A function to be called}
+
+\item{\code{fuzzy_output}}{Allow fuzzy results}
+
+\item{\code{expect_error}}{Expect errors}
+
+\item{\code{libraries}}{A charcter vector naming needed libraries}
+
+\item{\code{files}}{A character vector naming needed files, path relative to the test standards directory}
+
+\item{\code{record.all.commands}}{Should synchronization commands and commands to generate run-again-links be included in the command recording? Generally, this should be FALSE (the default).}
+}}
+
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
+}
+\keyword{classes}
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/RKTestResult-class.Rd b/rkward/rbackend/rpackages/rkwardtests/man/RKTestResult-class.Rd
deleted file mode 100644
index 17f03fc6..00000000
--- a/rkward/rbackend/rpackages/rkwardtests/man/RKTestResult-class.Rd
+++ /dev/null
@@ -1,11 +0,0 @@
-\name{RKTestResult-class}
-\alias{RKTestResult
--class}
-\alias{RKTestResult}
-\title{S4 class RKTestResult}
-\description{Class RKTestResult}
-\details{This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.}
-\keyword{classes}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}}
-\section{Slots}{\describe{\item{\code{id}:}{}\item{\code{code_match}:}{}\item{\code{output_match}:}{}\item{\code{message_match}:}{}\item{\code{error}:}{}\item{\code{missing_libs}:}{}\item{\code{passed}:}{}}}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/RKTestResult.Rd b/rkward/rbackend/rpackages/rkwardtests/man/RKTestResult.Rd
new file mode 100644
index 00000000..83c84289
--- /dev/null
+++ b/rkward/rbackend/rpackages/rkwardtests/man/RKTestResult.Rd
@@ -0,0 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/RKTestResult-class.R
+\docType{class}
+\name{RKTestResult}
+\alias{RKTestResult}
+\title{S4 Class RKTestResult}
+\description{
+This class is used internally by \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{id}}{A unique character string naming a test.}
+
+\item{\code{code_match}}{A character string indicating whether the run code matched the standard.}
+
+\item{\code{output_match}}{A character string indicating whether the resulting output matched the standard.}
+
+\item{\code{message_match}}{A character string indicating whether the resulting R messages matched the standard.}
+
+\item{\code{error}}{A character string indicating errors.}
+
+\item{\code{missing_libs}}{A character string indicating missing libraries.}
+
+\item{\code{passed}}{Logical: Did the test pass?}
+}}
+
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
+}
+\keyword{classes}
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite-class.Rd b/rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite-class.Rd
deleted file mode 100644
index 8852faf4..00000000
--- a/rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite-class.Rd
+++ /dev/null
@@ -1,11 +0,0 @@
-\name{RKTestSuite-class}
-\alias{RKTestSuite
--class}
-\alias{RKTestSuite}
-\title{S4 class RKTestSuite}
-\description{Class RKTestSuite}
-\details{This class is used to create test suite objects that can be fed to \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.}
-\keyword{classes}
-\author{Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}}
-\section{Slots}{\describe{\item{\code{id}:}{}\item{\code{libraries}:}{}\item{\code{initCalls}:}{}\item{\code{tests}:}{}\item{\code{postCalls}:}{}}}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite.Rd b/rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite.Rd
new file mode 100644
index 00000000..e48ed651
--- /dev/null
+++ b/rkward/rbackend/rpackages/rkwardtests/man/RKTestSuite.Rd
@@ -0,0 +1,27 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/RKTestSuite-class.R
+\docType{class}
+\name{RKTestSuite}
+\alias{RKTestSuite}
+\title{S4 Class RKTestSuite}
+\description{
+This class is used to create test suite objects that can be fed to \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}.
+}
+\section{Slots}{
+
+\describe{
+\item{\code{id}}{A unique character string to identify a test suite}
+
+\item{\code{libraries}}{A charcter vector naming libraries that the test suite depends on.}
+
+\item{\code{initCalls}}{A list of functions to be run before any tests, e.g. to load libraries or data objects.}
+
+\item{\code{tests}}{A list of the actual plugin tests.}
+
+\item{\code{postCalls}}{A list of functions to be run after all tests, e.g. to clean up.}
+}}
+
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
+}
+\keyword{classes}
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.expectError.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.expectError.Rd
new file mode 100644
index 00000000..5539c007
--- /dev/null
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.expectError.Rd
@@ -0,0 +1,36 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rktest.expectError.R
+\name{rktest.commandFailed}
+\alias{rktest.commandFailed}
+\alias{rktest.expectError}
+\title{Helper functions to check for expected errors}
+\usage{
+rktest.commandFailed(expr)
+
+rktest.expectError(expr, message = NULL)
+}
+\arguments{
+\item{expr}{Expression to evaluate}
+
+\item{message}{Error message to generate, if the expected error failed to occur. If NULL, the deparsed expression itself is cited.}
+}
+\value{
+TRUE if the command failed. rktest.commandFailed() returns FALSE, if the command did not fail.
+}
+\description{
+\code{rktest.commandFailed()} runs the given statement(s), which is expected to produce an error. Returns TRUE, if the command failed, FALSE, if it succeeded.
+\code{rktest.exptectError()} runs the given statement(s), which is expected to produce an error. If the command succeeds, and error is produced.
+}
+\note{
+In both cases, the error message of the original command will still be printed (as a warning), but execution will continue afterwards.
+}
+\examples{
+if(!rktest.commandFailed(stop("Expected error"))) stop("Failed to generate error")
+}
+\seealso{
+\code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\author{
+Thomas Friedrichsmeier \email{rkward-devel at kde.org}
+}
+\keyword{utilities}
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd
index d1bfa820..d69fd6b0 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.getTempDir.Rd
@@ -1,29 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rktest.getTempDir.R
 \name{rktest.getTempDir}
 \alias{rktest.getTempDir}
 \title{Get path to the temporary directory}
 \usage{
-  rktest.getTempDir()
+rktest.getTempDir()
 }
 \value{
-  Either a character string, or FALSE.
+Either a character string, or FALSE.
 }
 \description{
-  Get the path to the recent temporary directory, if one
-  exists.
+This function will return either the local path to the temporary directory where
+all test results have been saved to, or FALSE if none exitsts.
 }
 \details{
-  This function will return either the local path to the
-  temporary directory where all test results have been
-  saved to, or FALSE if none exitsts.
+Get the path to the recent temporary directory, if one exists.
 }
 \examples{
 rktest.getTempDir()
 }
-\author{
-  Meik Michalke \email{meik.michalke at uni-duesseldorf.de}
-}
 \seealso{
-  \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+\code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\author{
+Meik Michalke \email{meik.michalke at uni-duesseldorf.de}
 }
 \keyword{utilities}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd
index 90b2fda3..04dfc730 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.makeplugintests.Rd
@@ -1,40 +1,31 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rktest.makeplugintests.R
 \name{rktest.makeplugintests}
 \alias{rktest.makeplugintests}
 \title{Run RKWard plugin test suite}
 \usage{
-  rktest.makeplugintests(testsuites="testsuite.R",
-    testroot=getwd(), outfile="make_plugintests.txt",
-    append=FALSE, test.id=NULL)
+rktest.makeplugintests(testsuites="testsuite.R", testroot=getwd(),
+outfile="make_plugintests.txt", append=FALSE, test.id=NULL)
 }
 \arguments{
-  \item{testsuites}{A character string or vector naming the
-  test suites to be run.}
+\item{testsuites}{A character string or vector naming the test suites to be run.}
 
-  \item{testroot}{A character string pointing to the root
-  directory where the test suite resides (including its
-  folder with test standards).}
+\item{testroot}{A character string pointing to the root directory where the test suite resides (including its folder with test standards).}
 
-  \item{outfile}{A character string giving a file name for
-  the result log.}
+\item{outfile}{A character string giving a file name for the result log.}
 
-  \item{append}{If TRUE, append output to an existing
-  file.}
+\item{append}{If TRUE, append output to an existing file.}
 
-  \item{test.id}{Optional character string or vector naming
-  one or more tests of a suite to be run (if NULL, all
-  tests are run).}
+\item{test.id}{Optional character string or vector naming one or more tests of a suite to be run (if NULL, all tests are run).}
 }
 \value{
-  Results are printed to stdout and saved to the defined
-  output file.
+Results are printed to stdout and saved to the defined output file.
 }
 \description{
-  Run a whole RKWard plugin test suite
+The function \code{rktest.makeplugintests} will run a whole test suite that was prepared to check one or several RKWard plugins.
 }
 \details{
-  The function \code{rktest.makeplugintests} will run a
-  whole test suite that was prepared to check one or
-  several RKWard plugins.
+Run a whole RKWard plugin test suite
 }
 \examples{
 \dontrun{
@@ -44,14 +35,10 @@ rktest.makeplugintests(testsuites="distribution.R",
   testroot=getwd(), test.id=c("poisson_quantiles", "geom_quantiles"))
 }
 }
-\author{
-  Thomas Friedrichsmeier
-  \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik
-  Michalke \email{meik.michalke at uni-duesseldorf.de}
-}
 \seealso{
-  \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
-  \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}
+\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}
+}
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}
 }
 \keyword{utilities}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd
index cb0f6282..dd1aa903 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.replaceRunAgainLink.Rd
@@ -1,40 +1,35 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rktest.replaceRunAgainLink.R
 \name{rktest.replaceRunAgainLink}
-\alias{.rk.rerun.plugin.link.replacement}
 \alias{rktest.replaceRunAgainLink}
+\alias{.rk.rerun.plugin.link.replacement}
 \title{Replace "Run again" link in RKWard}
 \usage{
-  rktest.replaceRunAgainLink(restore=FALSE)
+rktest.replaceRunAgainLink(restore=FALSE)
 }
 \arguments{
-  \item{restore}{Logical: If TRUE, restore the original
-  behaviour.}
+\item{restore}{Logical: If TRUE, restore the original behaviour.}
 }
 \value{
-  Replaces the "Run again" link in RKWard with the code
-  that would have been called, or vice versa.
+Replaces the "Run again" link in RKWard with the code that would have been called, or vice versa.
 }
 \description{
-  Replace "Run again" link in RKWard with code
+You can use this to temporarily replace .rk.rerun.plugin.link (see example below).
+This way, after running a plugin, you are shown the call needed to run this
+plugin with those settings, instead of the link.
+
+This code can be used in a plugin test suite.
 }
 \details{
-  You can use this to temporarily replace
-  .rk.rerun.plugin.link (see example below). This way,
-  after running a plugin, you are shown the call needed to
-  run this plugin with those settings, instead of the link.
-
-  This code can be used in a plugin test suite.
+Replace "Run again" link in RKWard with code
 }
 \examples{
 rktest.replaceRunAgainLink()
 }
-\author{
-  Thomas Friedrichsmeier
-  \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik
-  Michalke \email{meik.michalke at uni-duesseldorf.de}
-}
 \seealso{
-  \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
-  \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}
 }
 \keyword{utilities}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd
index 3d5708c7..69ef5d20 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.runRKTestSuite.Rd
@@ -1,44 +1,36 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rktest.runRKTestSuite.R
 \name{rktest.runRKTestSuite}
 \alias{rktest.runRKTestSuite}
 \title{Run RKWard plugin test suite}
 \usage{
-  rktest.runRKTestSuite(suite, testroot=getwd(),
-    test.id=NULL)
+rktest.runRKTestSuite(suite, testroot=getwd(), test.id=NULL)
 }
 \arguments{
-  \item{suite}{Character string naming the test suite to
-  run.}
+\item{suite}{Character string naming the test suite to run.}
 
-  \item{testroot}{Defaults to the working directory.}
+\item{testroot}{Defaults to the working directory.}
 
-  \item{test.id}{An optional character string or vector
-  naming one or more tests of a suite to be run (if NULL,
-  all tests are run).}
+\item{test.id}{An optional character string or vector naming one or more tests of a suite to be run (if NULL, all tests are run).}
 }
 \value{
-  An object of class
-  \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}.
+An object of class \code{\link[rkwardtests:RKTestResult]{RKTestResult-class}}.
 }
 \description{
-  Run a single RKWard plugin test suite
+This function can be called to run a single plugin test suite.
 }
 \details{
-  This function can be called to run a single plugin test
-  suite.
+Run a single RKWard plugin test suite
 }
 \examples{
 \dontrun{
 result <- rktest.runRKTestSuite()
 }
 }
-\author{
-  Thomas Friedrichsmeier
-  \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik
-  Michalke \email{meik.michalke at uni-duesseldorf.de}
-}
 \seealso{
-  \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
-  \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}, Meik Michalke \email{meik.michalke at uni-duesseldorf.de}
 }
 \keyword{utilities}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
index 52b6948d..66c85e42 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rktest.setSuiteStandards.Rd
@@ -1,46 +1,39 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rktest.setSuiteStandards.R
 \name{rktest.setSuiteStandards}
 \alias{rktest.setSuiteStandards}
 \title{Set RKWard suite standards}
 \usage{
-  rktest.setSuiteStandards(suite, testroot=getwd(),
-    file=TRUE)
+rktest.setSuiteStandards(suite, testroot=getwd(), file=TRUE)
 }
 \arguments{
-  \item{suite}{Character string naming the test suite to
-  set standards for.}
+\item{suite}{Character string naming the test suite to set standards for.}
 
-  \item{testroot}{Path to the test root directory, defaults
-  to the working directory.}
+\item{testroot}{Path to the test root directory, defaults to the working directory.}
 
-  \item{file}{Logical: If \code{suite} is already a present
-  R object, set this to FALSE.  Otherwise it is assumed to
-  be a file and fed to \code{source}.}
+\item{file}{Logical: If \code{suite} is already a present R object, set this to FALSE.
+Otherwise it is assumed to be a file and fed to \code{source}.}
 }
 \value{
-  The function simply copies the previously created files
-  from the temporary directory to the directory containing
-  the test standards (inside the testroot).
+The function simply copies the previously created files from the temporary directory
+       to the directory containing the test standards (inside the testroot).
 }
 \description{
-  Set RKWard plugin test suite standards
+Use this function after you plugin passed all tests to set the resulting code,
+output and R messages as the standard that will be compared to during following tests.
 }
 \details{
-  Use this function after you plugin passed all tests to
-  set the resulting code, output and R messages as the
-  standard that will be compared to during following tests.
+Set RKWard plugin test suite standards
 }
 \examples{
 \dontrun{
 rktest.setSuiteStandards("rkward_application_tests.R")
 }
 }
-\author{
-  Thomas Friedrichsmeier
-  \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
-}
 \seealso{
-  \code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}},
-  \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+\code{\link[rkwardtests:RKTestSuite]{RKTestSuite-class}}, \code{\link[rkwardtests:rktest.makeplugintests]{rktest.makeplugintests}}
+}
+\author{
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
 }
 \keyword{utilities}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd b/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
index 46127cb2..28c15de6 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/rkwardtests-package.Rd
@@ -1,24 +1,29 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/rkwardtests-package.R
 \docType{package}
 \name{rkwardtests-package}
-\alias{rkwardtests}
 \alias{rkwardtests-package}
+\alias{rkwardtests}
 \title{RKWard Plugin Test Suite Framework.}
 \description{
-  RKWard Plugin Test Suite Framework.
+A set of functions, classes and methods to test plugins that were written for RKWard.
 }
 \details{
-  \tabular{ll}{ Package: \tab rkwardtests\cr Type: \tab
-  Package\cr Version: \tab 0.5.7\cr Date: \tab
-  2012-06-03\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 }
+RKWard Plugin Test Suite Framework.
 
-  A set of functions, classes and methods to test plugins
-  that were written for RKWard.
+\tabular{ll}{
+Package: \tab rkwardtests\cr
+Type: \tab Package\cr
+Version: \tab 0.5.7\cr
+Date: \tab 2012-06-03\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
+}
 }
 \author{
-  Thomas Friedrichsmeier, Meik Michalke
+Thomas Friedrichsmeier, Meik Michalke
 }
 \keyword{package}
-
diff --git a/rkward/rbackend/rpackages/rkwardtests/man/show.Rd b/rkward/rbackend/rpackages/rkwardtests/man/show.Rd
index 3e9955f0..c1ff432c 100644
--- a/rkward/rbackend/rpackages/rkwardtests/man/show.Rd
+++ b/rkward/rbackend/rpackages/rkwardtests/man/show.Rd
@@ -1,15 +1,19 @@
-\name{show}
-\alias{show}
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/show-method.R
+\name{show,RKTestResult-method}
 \alias{show,RKTestResult-method}
 \title{show method for objects of class RKTestResult}
+\usage{
+\S4method{show}{RKTestResult}(object)
+}
 \arguments{
-  \item{object}{An object of class RKTestResult}
+\item{object}{An object of class RKTestResult}
 }
 \description{
-  show method for S4 objects of class RKTestResult
+show method for S4 objects of class RKTestResult
 }
 \details{
-  Prints a summary of plugin test results.
+Prints a summary of plugin test results.
 }
 \examples{
 \dontrun{
@@ -17,8 +21,6 @@ rktest.makeplugintests("rkward_application_tests.R")
 }
 }
 \author{
-  Thomas Friedrichsmeier
-  \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
+Thomas Friedrichsmeier \email{thomas.friedrichsmeier at ruhr-uni-bochum.de}
 }
 \keyword{methods}
-
diff --git a/scripts/roxygenize.sh b/scripts/roxygenize.sh
index a32ac0cf..39a59aa6 100755
--- a/scripts/roxygenize.sh
+++ b/scripts/roxygenize.sh
@@ -7,9 +7,7 @@ PACKAGESDIR="${BASEDIR}/rkward/rbackend/rpackages"
 
 
 if [ "$#" = 0 ]; then
-	PACKAGES="'${PACKAGESDIR}/rkward/'"
-	# currently excluded due to missing support for slots in roxygen2:
-	# '${PACKAGESDIR}/rkward/tests/'
+	PACKAGES="'${PACKAGESDIR}/rkward/', '${PACKAGESDIR}/rkwardtests/'"
 else
 	PACKAGES="'$1'"
 	shift

More information about the rkward-tracker mailing list