HTMLStart: Start / Stop the automatic redirection of output to HTML files

Description

Add the automatic redirection of output to an HTML file. The R session is modified in the following way: a new prompt is proposed (by default HTML>) and each parsed command is also evaluated using HTML generic method, so that the user benefits of both a normal and a HTML output. Please read carefully the details below.

Usage

HTMLStart(outdir = tempdir(), filename = "index", extension = "html",
echo = FALSE, autobrowse = FALSE, HTMLframe = TRUE, withprompt = "HTML> ",
CSSFile = "R2HTML.css", BackGroundColor = "FFFFFF", BackGroundImg = "",
Title = "R output") 
HTMLStop()

Arguments

outdir

physical directory to store the output

filename

name of the target HTML main file

extension

extension of the target HTML file (htm, html,...)

echo

should the parsed commands be written in the output? [boolean]

autobrowse

should the browser be invoked each time a command is issued? [boolean]

HTMLframe

should the output have a HTML frame structure? [boolean]

withprompt

prompt to display while using HTMLStart/HTMLStop

CSSFile

path and name of a CSS file to use

BackGroundColor

option bgcolor for HTML tag <body>

BackGroundImg

option background for HTML tag <body>

Title

string to pass to HTML <title> tag

Value

no useful output is returned.

Details

The user may need to know the following points which describe how R2HTML does work:

- Each parsed command is evaluated and the returned value is passed to the generic function HTML. This evaluation is assured by addTaskCallback function, which is used to add a specific task each time R has to parse an expression.

- A new environment is built, where internal variables such as physical path are stored. This environment is not visible by the user. It is destroyed when calling HTMLStop.

Examples

Run this code

# NOT RUN {
# Perform's one's own direct report

dir.create(file.path(tempdir(),"R2HTML"))
HTMLStart(file.path(tempdir(),"R2HTML"),HTMLframe=FALSE, Title="My report",autobrowse=FALSE)
as.title("This is my first title")
x <- 1
y<- 2
x+y
HTMLStop()


## Use for interactive teaching course
if (interactive()){
	dir.create(file.path(tempdir(),"R2HTML"))
	HTMLStart(file.path(tempdir(),"R2HTML"),echo=TRUE)
	as.title("Manipulation vectors")
	1:10
	sum(1:10)
	c(1:10,rep(3,4))
	HTMLStop()
}
# }