rk.get.tempfile.name {rkward}R Documentation

Output file names

Usage

rk.get.tempfile.name(prefix="image", extension=".jpg")
rk.get.output.html.file()
rk.set.output.html.file(x)

Arguments

prefix a string, used as a filename prefix when saving images to the output file
extension a string, used as a filename extension when saving images to the output file
x a string, giving the filename of the of the output file

Details

In RKWard the output is saved as a html file which is located at "~/.rkward" by default. (TODO: make this platform free). The name of this html file can be retrieved and set using rk.get.output.html.file and rk.set.output.html.file.

rk.get.tempfile.name returns a non-existing filename inside the directory of the output file. It is mainly used by rk.graph.on to create filenames suitable for storing images in the output. The filenames of the temporary files are of the form "prefixxyz.extension". rk.get.tempfile.name is somewhat misnamed. For truly temporary files, tempfile is generally more suitable.

Value

rk.get.tempfile.name and rk.get.output.html.file returns a string while rk.set.output.html.file returns NULL.

Author(s)

Thomas Friedrichsmeier rkward-devel@lists.sourceforge.net

See Also

rkward://page/rkward_output, tempfile, file, rk.print

Examples

testfile.name <- rk.get.tempfile.name(prefix="test", extension=".txt")
testfile <- file(testfile.name)
cat("This is a test\n", file=testfile)
close(testfile)
unlink(testfile.name)

outfile <- rk.get.output.html.file()

## Not run
rk.set.output.html.file("~/.rkward/another_file.html")
rk.header("Output on a different output file")
rk.show.html(rk.get.output.html.file())
rk.set.output.html.file(outfile)

[Package rkward version 0.5.4 Index]