1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
|
\name{HTML.data.frame}
\alias{HTML.data.frame}
\alias{HTML.matrix}
\title{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{\method{HTML}{data.frame}(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{
\item{x}{ a data.frame}
\item{file}{ target HTLM output}
\item{Border}{ the size of the border around the table. Could be 0,1,... but also NULL}
\item{innerBorder}{ the size of the border inside the table - see details}
\item{classfirstline}{ CSS class for the first line (header - variable names) }
\item{classfirstcolumn}{ CSS class for the first column (rownames)}
\item{classcellinside}{ CSS class for others cells}
\item{append}{ logical. If 'TRUE' output will be appended to 'file'; otherwise, it will overwrite the contents of 'file'}
\item{align}{ alignment to be used: center, left or right}
\item{caption}{ optional caption to append to the table }
\item{captionalign}{ alignment to be used for the caption: could be bottom or top}
\item{classcaption}{ CSS class to use for caption}
\item{classtable}{ CSS class to be used for the whole table (in html <table> statement)}
\item{digits}{ number of digits to use for rounding}
\item{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'}
\item{big.mark}{ character; if not empty used as mark between every 'big.interval' decimals before (hence 'big') the decimal point}
\item{big.interval}{ see 'big.mark' above; defaults to 3}
\item{decimal.mark}{the character used to indicate the numeric decimal point}
\item{sortableDF}{See details}
\item{row.names}{ logical. If 'TRUE' row.names are shown in the output; otherwise they are omitted}
\item{\dots}{ ...}
}
\details{
For the moment, \code{HTML.matrix} and \code{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 \code{format} is called to format numerical values (modif. suggested by Arne Henningsen). The corresponding arguments are: \code{digits}, \code{nsmall}, \code{big.mark}, \code{big.intervall} and \code{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):
\code{getOption("R2HTML.format.decimal.mark")} and {options("R2HTML.format.decimal.mark"=",")}
Sortable data.frame uses a DHTML behavior. This requires the file \file{tablesort.htc} which comes with \pkg{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).
}
\value{
no value returned.
}
\author{ Eric Lecoutre}
\seealso{ \code{\link{HTML}}}
\examples{
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:
\dontrun{browseURL(tmpfic)}
# 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="")
}
\keyword{datasets}
\keyword{IO}
|
