HTML.data.frame: Write a data.frame (or matrix) to a HTML output

Description

This function exports a data.frame to a HTML file. Many arguments allow to customize the layout of the HTML table.

Usage

# S3 method for data.frame
HTML(x, file = HTMLGetFile(),
    Border = 1, innerBorder = 0, classfirstline = "firstline",
    classfirstcolumn = "firstcolumn", classcellinside = "cellinside",
    append = TRUE, align = "center", caption = "", captionalign = "bottom",
    classcaption = "captiondataframe", classtable = "dataframe",
    digits = getOption("R2HTML.format.digits"),
    nsmall = getOption("R2HTML.format.nsmall"),
    big.mark = getOption("R2HTML.format.big.mark"),
    big.interval = getOption("R2HTML.format.big.interval"),
    decimal.mark = getOption("R2HTML.format.decimal.mark"),
    sortableDF = getOption("R2HTML.sortableDF"), row.names = TRUE, ...)

Arguments

a data.frame

file

target HTLM output

Border

the size of the border around the table. Could be 0,1,... but also NULL

innerBorder

the size of the border inside the table - see details

classfirstline

CSS class for the first line (header - variable names)

classfirstcolumn

CSS class for the first column (rownames)

classcellinside

CSS class for others cells

append

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

align

alignment to be used: center, left or right

caption

optional caption to append to the table

captionalign

alignment to be used for the caption: could be bottom or top

classcaption

CSS class to use for caption

classtable

CSS class to be used for the whole table (in html <table> statement)

digits

number of digits to use for rounding

nsmall

number of digits which will always appear to the right of the decimal point in formatting real/complex numbers in non-scientific formats. Allowed values '0 <= nsmall <= 20'

big.mark

character; if not empty used as mark between every 'big.interval' decimals before (hence 'big') the decimal point

big.interval

see 'big.mark' above; defaults to 3

decimal.mark

the character used to indicate the numeric decimal point

sortableDF

See details

row.names

logical. If 'TRUE' row.names are shown in the output; otherwise they are omitted

…

...

Value

no value returned.

Details

For the moment, HTML.matrix and HTML.data.frame do have the same options. Tables are build using two different HTML tables, one beeing encapsulated within the other, which allows to have a table without borders inside but with a border outside. It is nevertheless recommended to rely on CSS to obtain such results...

Now format is called to format numerical values (modif. suggested by Arne Henningsen). The corresponding arguments are: digits, nsmall, big.mark, big.intervall and decimal.mark. For each argument, one can supply either a single value or a vector. In the second case, the size of the vector has to be the number of columns of the data.frame and formatting options will be used element-wise (column by column).

Some options are used to pass default values. You can see those options with (by example): getOption("R2HTML.format.decimal.mark") and options("R2HTML.format.decimal.mark"=",")

Sortable data.frame uses a DHTML behavior. This requires the file tablesort.htc which comes with R2HTML to be placed in the same directory than the output. This functionality only works for HTML files located on a web server (not on local computer).

Examples

Run this code

# NOT RUN {
tmpfic=HTMLInitFile(tempdir(),CSSFile=system.file("samples", "R2HTML.css", package="R2HTML"))
data(iris)
HTML(as.title("Fisher Iris dataset"),file=tmpfic)
HTML(iris, file=tmpfic)
# File is generated, you can call the browser:
# }
# NOT RUN {
browseURL(tmpfic)
# }
# NOT RUN {
# Export one line of iris using default decimal separator
HTML(iris[1,],file="")

# Seeing default decimal separator:
getOption("R2HTML.format.decimal.mark")

# Modifying it:
options("R2HTML.format.decimal.mark"=",")
HTML(iris[1,],file="")

# Bypassing value set in option:
HTML(iris[1,],file="",decimal.mark="*")

# Using a vector for formatting options
HTML(iris[1:2,1:2],nsmall=c(3,1),file="")
# }