# Copyright 2010-2014 Meik Michalke <meik.michalke@hhu.de>
#
# This file is part of the R package rkwarddev.
#
# rkwarddev is free software: you can redistribute it and/or modify
# it under the terms of the GNU General Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# rkwarddev is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with rkwarddev. If not, see <http://www.gnu.org/licenses/>.
#' Create testsuite outline to test an RKWard plugin
#'
#' @param name A character string, name of the plugin/dialog.
#' @return A character string.
#' @seealso \href{help:rkwardplugins}{Introduction to Writing Plugins for RKWard}
#' @export
rk.testsuite.doc <- function(name=NULL){
suite.text <- paste0("## definition of the test suite
suite <- new(\"RKTestSuite\",
id=\"", name ,"\",
## needed packages
libraries = c(\"", name ,"\"),
## initCalls are run *before* any tests. Use this to set up the environment
initCalls = list(
function(){
## e.g. load needed packages
# require(\"package\")
## or prepare needed data objects
# data(\"sampledata\")
## or create needed objects
# object <- NULL
# assign(\"object.name\", object, envir=globalenv())
},
function(){
## if some tests depend on results of earlier tests,
## you can store those in a list in .GlobalEnv
# earlier.results <<- list()
}
),
## the tests
tests = list(
## define the actual tests here
# new(\"RKTest\", id=\"\", call=function(){
# rk.call.plugin(\"rkward::...\", ..., submit.mode=\"submit\")
## to store these results:
# earlier.results$this.result1 <<- this.result
# }),
# new(\"RKTest\", id=\"\", call=function(){
# rk.call.plugin(\"rkward::...\", ..., submit.mode=\"submit\")
## to store these results:
# earlier.results$this.result2 <<- this.result
# })
),
## postCalls are like initCalls, but run after all tests to clean up.
postCalls = list(
function(){
## e.g. remove created objects
# rm(list=c(\"earlier.results\"), envir=globalenv())
}
)
)")
return(suite.text)
}
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.