File: toHTML.Rd

package info (click to toggle)
r-cran-xml 3.99-0.19-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 3,688 kB
  • sloc: ansic: 6,659; xml: 2,890; asm: 486; sh: 12; makefile: 2
file content (51 lines) | stat: -rw-r--r-- 1,380 bytes parent folder | download | duplicates (9)
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
\name{toHTML}
\alias{toHTML}
\alias{toHTML,vector-method}
\alias{toHTML,matrix-method}
\alias{toHTML,call-method}

\title{Create an HTML representation of the given R object, using
  internal C-level nodes}
\description{
  This generic function and the associated methods are
  intended to create an HTML tree that represents the
  R object in some intelligent manner.
  For example, we represent a vector as a table
  and we represent a matrix also as a table.
  
}
\usage{
toHTML(x, context = NULL)
}
\arguments{
  \item{x}{ the R object which is to be represented via an HTML tree }
  \item{context}{an object which provides context in which the node will
    be used. This is currently arbitrary. It may be used, for example,
    when creating HTML for R documentation and providing information
    about variabes and functions that are available on that page
    and so have internal links.
  }
}
\details{
  It would be nicer if we could pass additional arguments
  to control whether the outer/parent layer is created,
  e.g. when reusing code for a vector for a row of a matrix.
}
\value{
 an object of class \code{XMLInternalNode}
}
%\references{  }
\author{Duncan Temple Lang}

\seealso{
 The \code{R2HTML} package.
}
\examples{
 cat(as(toHTML(rnorm(10)), "character"))
}
\keyword{IO}
\keyword{programming}
\concept{XML}
\concept{serialization}
\concept{data exchange}