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
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
|
\name{latex.Design}
\alias{latexDesign}
\alias{latex.Design}
\alias{latex.bj}
\alias{latex.glmD}
\alias{latex.glsD}
\alias{latex}
\title{LaTeX Representation of a Fitted Model}
\description{
Creates a file containing a LaTeX representation of the fitted model. For
model-specific typesetting there is \code{latex.lrm}, \code{latex.cph},
\code{latex.psm} and \code{latex.ols}. \code{latex.cph} has some
arguments that are specific to \code{cph} models. These routines work
with the \code{display} package from statlib to display and print the
formatted model fits. \code{latexDesign} is the core function which is
called internally by \code{latex.Design} (which is called by
\code{latex.cph}, \code{latex.ols}, etc.).
}
\synopsis{
latexDesign(object, file=paste(first.word(deparse(substitute(object))),".tex",sep=""),
append=FALSE, which=1:p, varnames, columns=65, prefix=NULL, inline=FALSE,
before=if(inline)"" else "& &", intercept, pretrans=TRUE,
digits=.Options$digits)
}
\usage{
latex(object, title,
file=paste(first.word(deparse(substitute(object))),'tex',sep='.'), \dots)
}
\arguments{
\item{object}{
a fit object created by a fitting function in the \code{Design} series
}
\item{title}{ignored}
\item{file}{
name of \code{.tex} file to create, default is first word of argument
\code{object} with \code{".tex"} added. Set to \code{""} to send LaTeX
output to standard output.
}
\item{\dots}{further arguments, including
\describe{
\item{\code{append}}{whether or not to append to an existing file}
\item{\code{which}}{
a vector of subcripts (corresponding to \code{object$Design$name})
specifying a submodel to print. Default is to describe the whole
model.
\code{which} can also be a vector of character strings specifying the
factor names to print. Enough of each string is needed to ensure
a unique match. Names for interaction effects are of the form
\code{"age * sex"}. For any interaction effect for which you do not
request main effects, the main effects will be added to \code{which}.
When \code{which} is given, the model structural statement is not
included. In this case, intercepts are not included either.
}
\item{\code{varnames}}{
variable names to substitute for non-interactions. Order must correspond
to \code{object$Design$name} and interactions must be omitted.
Default is
\code{object$Design$name[object$Design$assume.code!=9]}. \code{varnames} can contain any LaTeX commands such as subscripts and "\\\\\\\\frac"
(all "\\" must be quadrupled.)
Any "/" must be preceeded by "\\\\" (2, not 4 backslashes).
Elements of \code{varnames} for interactions are ignored; they can be
set to any value.
}
\item{\code{columns}}{
maximum number of columns of printing characters to allow before
outputting a LaTeX newline command
}
\item{\code{prefix}}{
if given, a LaTeX \\lefteqn command of the form \code{\\lefteqn\{prefix =\} \\\\}
will be inserted to print a left-hand-side of the equation.
}
\item{\code{inline}}{
Set to \code{TRUE} to create text for insertion in an in-line equation. This
text contains only the expansion of X beta, and is not surrounded by
\code{"$"}.
}
\item{\code{before}}{
a character string to place before each line of output. Use the default
for a LaTeX \code{eqnarray} environment.
}
\item{\code{intercept}}{
a special intercept value to include that is not part of the standard
model parameters (e.g., centering constant in Cox model). Only allowed
in the \code{latex.Design} rendition.
}
\item{\code{pretrans}}{
if any spline or polynomial-expanded variables are themselves
transformed, a table of pre-transformations will be formed unless
\code{pretrans=FALSE}.
}
\item{\code{digits}}{number of digits of precision to use in formatting
coefficients and other numbers}
}
Other arguments in '...' will be passed to \code{latex.default}.
}
}
\value{a file name of class \code{"latex"}}
\author{
Frank Harrell\cr
Department of Biostatistics, Vanderbilt University\cr
f.harrell@vanderbilt.edu
}
\seealso{
\code{\link[Hmisc]{latex}}, \code{\link[Hmisc]{rcspline.restate}},
\code{\link{Design}}
}
\examples{
\dontrun{
f <- lrm(death ~ rcs(age)+sex)
w <- latex(f)
w # displays, using e.g. xdvi
latex(f, file="") # send LaTeX code to screen
}
}
\keyword{models}
\keyword{regression}
\keyword{character}
\keyword{methods}
\keyword{interface}
|
