HTML.function: Writes the code of a function to a target HTML file

Description Usage Arguments Details Value Note Author(s) See Also Examples

Description

Writes the code of a function to a target HTML file

Usage

1
2
## S3 method for class 'function'
HTML(x, file = get(".HTML.file"), append=TRUE, ...)

Arguments

x

Name of a function

file

target HTLM output

append

logical. If 'TRUE' output will be appended to 'file'; otherwise, it will overwrite the contents of 'file'

...

...

Details

The code of the function is written in the target HTML file, using HTML <XMP> tag. A CSS class called "function" is used to personalise the output.

Value

no value returned.

Note

For a discussion about .HTML.file default value for file argument, refer to HTMLStart

Author(s)

Eric Lecoutre

See Also

HTML

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
## Define a function and export it's code to the file /test.html.
## Target file may be changed when submitting this code...

myfile <- paste(tempfile(),".html",sep="")
myfun <- function(x){
	cat("\n Euclidian norm")
	return(sqrt(sum(x^2)))
 }
HTML(myfun,file=myfile)
cat("\n Test output written in: ",myfile)

R2HTML documentation built on May 2, 2019, 5:11 p.m.

Related to HTML.function in R2HTML...