latex.cph {rms} | R Documentation

## LaTeX Representation of a Fitted Cox Model

### Description

Creates a file containing a LaTeX representation of the fitted model.

### Usage

    ## S3 method for class 'cph'
    latex(object, title,
          file='',
          append=FALSE, surv=TRUE, maxt=FALSE, which=NULL, varnames, columns=65,
          inline=FALSE, before=if(inline)"" else "& &", after="", dec=3,
          pretrans=TRUE, caption, digits=.Options$digits, size="",
          ...) # for cph fit

    ## S3 method for class 'lrm'
    latex(object, title, file, append, which, varnames,
    columns, inline, before, after, pretrans, caption,
    digits=.Options$digits, size="", ...) # for lrm fit

    ## S3 method for class 'ols'
    latex(object, title, file, append, which, varnames,
    columns, inline, before, after, pretrans, caption,
    digits=.Options$digits, size="", ...) # ols fit

    ## S3 method for class 'orm'
    latex(object, title, file, append, which, varnames,
    columns, inline, before, after, pretrans, caption,
    digits=.Options$digits, size="", intercepts=nrp < 10, ...) # for orm fit

    ## S3 method for class 'pphsm'
    latex(object, title, file, append, which=NULL, varnames,
    columns, inline, before, after, pretrans, caption,
    digits=.Options$digits, size="", ...) # pphsm fit

    ## S3 method for class 'psm'
    latex(object, title, file, append, which=NULL, varnames,
    columns, inline, before, after, pretrans, caption,
    digits=.Options$digits, size="", ...) # psm fit

### Arguments

`object` | a fit object created by a `rms` fitting function.
`title` | ignored
`file,append` | see `latex.default`. Defaults to the console. When usinghtml/markdown, `file` is ignored.
`surv` | if `surv=TRUE` was specified to `cph`, the underlying survival probabilities from `object$surv.summary` will be placed in a table unless `surv=FALSE`.
`maxt` | if the maximum follow-up time in the data (`object$maxtime`) exceeds the last entry in `object$surv.summary`, underlying survival estimates at `object$maxtime` will be added to the table if `maxt=TRUE`.
`which,varnames,columns,inline,before,dec,pretrans` | see `latex.default`
`after` | if not an empty string, added to end of markup if `inline=TRUE`
`caption` | a character string specifying a title for the equation to be centered and typeset in bold face. Default is no title.
`digits` | see latexrms
`size` | a LaTeX size to use, without the slash. Default is the prevailing size
`intercepts` | for `orm` fits. Default is to print intercepts if they are fewer than 10 in number. Set to `TRUE` or `FALSE` to force.
`...` | ignored

### Value

the name of the created file, with class `c("latex","file")`. This object works with latex viewing and printing commands in Hmisc.

### Author(s)

Frank Harrell
Department of Biostatistics, Vanderbilt University
f.harrell@vanderbilt.edu

### See Also

`latexrms`, `rcspline.restate`, `latex`

### Examples

    ## Not run:
    units(ftime) <- "Day"
    f <- cph(Surv(ftime, death) ~ rcs(age)+sex, surv=TRUE, time.inc=60)
    w <- latex(f, file='f.tex')  #Interprets fitted model and makes table of S0(t)
                   #for t=0,60,120,180,...
    w              #displays image, if viewer installed and file given above
    latex(f)   # send LaTeX code to the console for knitr
    options(prType='html')
    latex(f)       # for use with knitr and R Markdown using MathJax

    ## End(Not run)

[Package rms version 5.1-1 Index]