File: HTMLstem.Rd

package info (click to toggle)
r-cran-r2html 2.3.4%2Bdfsg-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 976 kB
  • sloc: javascript: 832; xml: 56; makefile: 12; sh: 8
file content (35 lines) | stat: -rwxr-xr-x 1,250 bytes parent folder | download | duplicates (2)
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
\name{HTMLstem}
\alias{HTMLstem}
%- Also NEED an '\alias' for EACH other topic documented here.
\title{Insert a stem-and-leaf plot in the HTML output}
\description{
  Insert a stem-and-leaf plot in the HTML output.
}
\usage{
HTMLstem(x, file = HTMLGetFile(), append = TRUE, ...)
}
%- maybe also 'usage' for other objects documented here.
\arguments{
  \item{x}{  a numeric vector.}
  \item{file}{ the target HTML file  }
  \item{append}{logical. If 'TRUE' output will be appended to 'file'; otherwise, it will overwrite the contents of 'file'}
  \item{\dots}{ any other argument that may be passed to \code{stem}, such as scale,...}
}
\details{
 As \code{stem} internal function does not return anything but directly print to console, there is no way to automatically export it to the HTML output. Thus, \code{HTMLstem} simply captures the output and write it to the HTML file. When using the package in a interactive way, you should call \code{HTMLstem}.
}
\value{
	no value returned.  }

\author{ Eric Lecoutre}


\seealso{ \code{\link{stem}},\code{\link{HTML}}}
\examples{
	data(islands)
	tmpfic=paste(tempfile(),"html",sep=".")
	HTMLstem(log10(islands),tmpfic)
	cat("\n stem-and-leaf writen to:", tmpfic,"\n")
}
\keyword{ IO }
\keyword{ univar }