The R Project SVN R

Rev

Rev 68948 | 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
68948 ripley 2 
% Part of the R package, https://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}
73574 hornik 10 
\title{Display an Object in HTML}
50445 murdoch 11 
\description{
12 
This generic function generates a complete HTML page from an object.
13 
}
14 
\usage{
15 
toHTML(x, ...)
16 
\S3method{toHTML}{packageIQR}(x, ...)
50546 murdoch 17 
\S3method{toHTML}{news_db}(x, ...)
50445 murdoch 18 
}
19 
\arguments{
20 
  \item{x}{ An object to display. }
50546 murdoch 21 
  \item{\dots}{ Optional parameters for methods; the \code{"packageIQR"} and
22 
  \code{"news_db"} methods pass these to \code{\link{HTMLheader}}. }
50445 murdoch 23 
}
24 
\value{
25 
A character vector to display the object \code{x}.  The \code{"packageIQR"} method
26 
is designed to display lists in the \R{} help system.
27 
}
28 
\seealso{
29 
\code{\link{HTMLheader}}
30 
}
31 
\examples{
61160 ripley 32 
cat(toHTML(demo(package = "base")), sep = "\n")
50445 murdoch 33 
}
34 
\keyword{ utilities }
35 
\keyword{ documentation }