HTML.title: Writes a title in a target HTML output

In R2HTML: HTML Exportation for R Objects

Writes a title in a target HTML output

Description

A title is a string with the S3 class "title". The function as.title gives this class to an object, so that title method of HTML could apply to it. However, it is also possibly to call this method, explicitly, providing a plain string.

Usage

## S3 method for class 'title'
HTML(x, HR = 2, CSSclass=NULL,
file = HTMLGetFile(), append=TRUE,...)
as.title(x)

Arguments

x	string
HR	rank attribute of the HTML <H?> tag
CSSclass	CSS class to use for personalised reports
file	the target HTML file
append	logical. If 'TRUE' output will be appended to 'file'; otherwise, it will overwrite the contents of 'file'
...	...

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

## Write a title in the file /test.html.
## Target file may be changed when submitting this code...

myfile <- paste(tempfile(),".html",sep="")

tit1 <- as.title("This is method 1")

HTML(tit1, file=myfile)

HTML.title("This is method 2",file=myfile, HR=3)
cat("\n Test output written in: ",myfile)

R2HTML documentation built on May 23, 2022, 5:06 p.m.