The R Project SVN R

Rev

Rev 59039 | Go to most recent revision | Details | Compare with Previous | Last modification | View Log | RSS feed

Rev Author Line No. Line
54635 ripley 1 
% File src/library/tools/man/toHTML.Rd
2 
% Part of the R package, http://www.R-project.org
59039 ripley 3 
% Copyright 2010-1 R Core Team
54635 ripley 4 
% Distributed under GPL 2 or later
5 
 
50445 murdoch 6 
\name{toHTML}
56186 murdoch 7 
\alias{toHTML}
50445 murdoch 8 
\alias{toHTML.packageIQR}
50546 murdoch 9 
\alias{toHTML.news_db}
50445 murdoch 10 
\title{
11 
Display an object in HTML.
12 
}
13 
\description{
14 
This generic function generates a complete HTML page from an object.
15 
}
16 
\usage{
17 
toHTML(x, ...)
18 
\S3method{toHTML}{packageIQR}(x, ...)
50546 murdoch 19 
\S3method{toHTML}{news_db}(x, ...)
50445 murdoch 20 
}
21 
\arguments{
22 
  \item{x}{ An object to display. }
50546 murdoch 23 
  \item{\dots}{ Optional parameters for methods; the \code{"packageIQR"} and
24 
  \code{"news_db"} methods pass these to \code{\link{HTMLheader}}. }
50445 murdoch 25 
}
26 
\value{
27 
A character vector to display the object \code{x}.  The \code{"packageIQR"} method
28 
is designed to display lists in the \R{} help system.
29 
}
30 
\seealso{
31 
\code{\link{HTMLheader}}
32 
}
33 
\examples{
61160 ripley 34 
cat(toHTML(demo(package = "base")), sep = "\n")
50445 murdoch 35 
}
36 
\keyword{ utilities }
37 
\keyword{ documentation }