A XML-Based Testing Framework for Automated Component Tests of R Packages


[Up] [Top]

Documentation for package ‘RTest’ version 1.2.2

Help Pages

A C E G H I N P R S T W X

RTest-package RTest: A XML-based Testing System For R Packages

-- A --

arguments_creator Read arguments from RTest 'param'-XML Node

-- C --

clearTest Clear Test Reporter and Test Cache of Last Test Case Execution
clearTest-method Clear Test Reporter and Test Cache of Last Test Case Execution

-- E --

example_data_frame Function changing a data frame by adding a column
example_image Function returning the Roche logo as an image at tempdir
example_list Function returning a list with three values
example_variable Function returning relative difference of X and Y
example_vector Function returning a character vector of length "rep"
exec Tests imported Test Cases
exec-method Tests imported Test Cases
execAdapter Execute the Adapter Function of the Test Case
execAdapter-method Execute the Adapter Function of the Test Case
execCache Execution Cache for Test Function
execCache-method Execution Cache for Test Function

-- G --

generic Generic test adapter Method
generic-method Generic test adapter Method
getExecDetails.html Create Detailed HTML Summary of the Last Execution of the Test Case
getExecDetails.html-method Create Detailed HTML Summary of the Last Execution of the Test Case
getExecStates Execution Statues of TCs
getExecStates-method Execution Statues of TCs
getExecSummary Summary of the Last Execution of the Test Case
getExecSummary-method Summary of the Last Execution of the Test Case
getExecSummary.html Create HTML Summary of the Last Execution of the Test Case
getExecSummary.html-method Create HTML Summary of the Last Execution of the Test Case
getID Get ID of the Test Case
getID-method Get ID of the Test Case
getRTM Get RTM for all executed test cases
getRTM-method Get RTM for all executed test cases
getRTMInfos Create RTM from executed test cases
getRTMInfos-method Create RTM from executed test cases
getRTMInMatrixShape Get RTM for all executed test cases in a matrix shape
getRTMInMatrixShape-method Get RTM for all executed test cases in a matrix shape
getSynopsis Get Synopsis of the Test Case
getSynopsis-method Get Synopsis of the Test Case
getTC Return Imported Test Case
getTC-method Return Imported Test Case
getTestFor Get For of Last Execution of the Test Case
getTestFor-method Get For of Last Execution of the Test Case
getTestResult Get Result of Last Execution of the Test Case
getTestResult-method Get Result of Last Execution of the Test Case
getType Get Type of the Test Case
getType-method Get Type of the Test Case
getValidTCs Get a List of TCs
getValidTCs-method Get a List of TCs
getXMLRoot Get the XML Root of the Test Case
getXMLRoot-method Get the XML Root of the Test Case
getXMLSourceFileName Get File Name of the XML Input File of the Test Case
getXMLSourceFileName-method Get File Name of the XML Input File of the Test Case
getXMLSourcePath Get Path to the XML Input File of the Test Case
getXMLSourcePath-method Get Path to the XML Input File of the Test Case
get_existence_of_fun Find out if a function is available

-- H --

htmlify_string function to make strings xml and html compatible

-- I --

importTC Import Test Case from XML File
importTC-method Import Test Case from XML File
importTCsFromDir Import all Test Cases from XML Files of a Directory
importTCsFromDir-method Import all Test Cases from XML Files of a Directory
initializeTests Initialize the Test Slot for a Test Case.
initializeTests-method Initialize the Test Slot for a Test Case.

-- N --

normalizeDate Reformat a Date String

-- P --

package_md5 Function to derive an md5 hash of a package in a current session
png2base64 Converts a PNG File Into a Base64 String for Using IT as Inline Image in HTML Files

-- R --

readXMLInputData Read Input Data of Test Case for Default XML Definitions
readXMLInputData-method Read Input Data of Test Case for Default XML Definitions
RTest RTest: A XML-based Testing System For R Packages
RTest.cat Write Text To Console
RTest.execute Function to generally execute a Test Case collection
RTest.print Print Text To Console
RTestCase Constructor for RTestCase
RTestCase-class The 'RTestCase' Class
RTestCollection-class Class Definition 'RTestCollection'

-- S --

setTestMethod Create and Save a Default Test Method For a Test Case Adapter
show-method Print Summary of the Test Case to Console
show-method Show Summary of RTestCollection Instance
summary-method Execution Summary As R Data Object
systemInfo.host Summarize Host System Information
systemInfo.packages Summarize System Packages
systemInfo.RInst Summarize R Version Information

-- T --

test Execute Test Logic of the Test Case
test-method Execute Test Logic of the Test Case
test.RTest.funct_01 Test Function For Testing Function 'RTest::test_returnValue_data.frame_cellbycell'
test.RTest.funct_01-method Test Function For Testing Function 'RTest::test_returnValue_data.frame_cellbycell'
test.RTest.test_returnValue_data.frame_cellbycell Test Function For Testing Function 'RTest::test_returnValue_data.frame_cellbycell'
test.RTest.test_returnValue_data.frame_cellbycell-method Test Function For Testing Function 'RTest::test_returnValue_data.frame_cellbycell'
test_execution Tests Silent Execution of an Function
test_fun A simple function to Test the RTest package
test_manualCheck_confirmWindow Creates a Tcl/Tk Window for confirmation of the manual check
test_manualCheck_file Creates a manual check via tcl/tk interface of created output file
test_returnValue_any Generically compare two values with RTest
test_returnValue_data.frame_cellbycell Tests a Standard R 'data.frame' Cell-By-Cell ('RTestTest_data.frame_cellbycell')
test_returnValue_data.frame_shape Tests a Standard R 'data.frame' by shape, rownames and colnames ('RTestTest_data.frame_shape')
test_returnValue_image Tests an image file with ImageMagick ('RTestTest_image')
test_returnValue_list_nodebynode Tests a Standard R 'list' Node-By-Node ('RTestTest_list_nodebynode')
test_returnValue_variable Tests a Standard R 'variable' ('RTestTest_vector_variable')
test_returnValue_vector_elementbyelement Tests a Standard R 'vector' Element-By-Element ('RTestTest_vector_elementbyelement')

-- W --

writeExecSummary.html Write Summary of Last Test Case Executions as HTML
writeExecSummary.html-method Write Summary of Last Test Case Executions as HTML

-- X --

xmlFromList Creat an XML Node from a list
xmlRead.default General import function to reads XML data of different types
xmlReadData_data.frame Read XML Data From Type 'xmlReadData_data.frame' as R 'data.frame'
xmlReadData_image Read XML Data From Type 'xmlReadData_image' as R Variable
xmlReadData_list Read XML Data From Type 'xmlReadData_list' as R 'list' (DUMMY)
xmlReadData_text Read XML Data From Type 'xmlReadData_text' as R Variable
xmlReadData_to_list Read an unidentified List of Data Types from TestCase params
xmlReadData_variable Read XML Data From Type 'xmlReadData_variable' as R Variable
xmlReadData_vector Read XML Data From Type 'xmlReadData_vector' as R Vector
xmlWriteContext Write the Opening (Header, Root-Tag) and Closing for a RTestCase
xmlWriteData_data.frame Write a R 'data.frame' as XML Data of Type 'xmlReadData_data.frame'
xmlWriteData_list Write a R 'list' as XML Data of Type 'xmlReadData_list'
xmlWriteData_variable Write a R 'constat' as XML Data of Type 'xmlReadData_variable'
xmlWriteData_vector Write a R 'vector' as XML Data of Type 'xmlReadData_vector'
xmlWriteInputData Write the Input-Data section for a RTestCase
xmlWriteSynopsis Write the Synopsis for a RTestCase
xmlWriteTest Write the Test section for a RTestCase
xmlWriteTestFunction Write the Test section for a RTestCase
xmlWriteTests Write the Tests section for a RTestCase
xmlWriteTestSpec Write the testpsec section for a RTestCase
xmlWriteTest_data.frame_cellbycell Write XML Test Definition of Type 'RTestTest_data.frame_cellbycell'
xmlWriteTest_execution Write XML Test Definition of Type 'RTestTest_execution'
xmlWriteTest_list_nodebynode Write XML Test Definition of Type 'RTestTest_list_nodebynode'
xmlWriteTest_variable Write XML Test Definition of Type 'RTestTest_variable'
xmlWriteTest_vector_elementbyelement Write XML Test Definition of Type 'RTestTest_vector_elementbyelement'