gdiff: Generate and Compare Control and Test Output

Description

Generate a set of "control" graphical output files in one directory, a set of "test" graphical output files in another directory, and compare the two sets of output files (possibly generating "compare" graphical output of the differences in a third directory).

Usage

gdiff(x, ...)
# S3 method for function
gdiff(x, name=deparse(substitute(x)), ...)
# S3 method for list
gdiff(x, name, ...)

Value

A "gdiffComparison" object, which is a list containing information about the output files generated and the differences detected.

Arguments

x

Either a function, or a named list of functions (with names control and test).

name

A name to be used for output files.

...

Further arguments, currently including:

controlDir, testDir, compareDir: The names of the directories where output is produced.

clean

A logical indicating whether the output directories should be emptied. Can also be a list of logicals with names control, test, and compare.

compare

A logical indicating whether to perform the comparison step.

device

A specification of the graphics device to use for output; see gdiffDevice. Can also be a list of graphics devices.

session

A specification of the R session to use for output; see gdiffSession. Can also be a list of sessions with names control and test.

ncpu

How many cpus to employ when generating output.

Author

Paul Murrell

Examples

Run this code

f <- function() plot(1)
# \donttest{
gdiff(f,
      controlDir=file.path(tempdir(), "Control"),
      testDir=file.path(tempdir(), "Test"),
      compareDir=file.path(tempdir(), "Compare"))
# }