summary.crr2: 'crr2' summary method

View source: R/crr2.R

summary.crr2R Documentation

crr2 summary method

Description

crr2 summary method

Usage

## S3 method for class 'crr2'
summary(
  object,
  conf.int = 0.95,
  n = FALSE,
  ref = FALSE,
  html = FALSE,
  combine_ci = html,
  digits = 2L,
  format_p = html,
  color_p = html,
  format_n = n,
  htmlArgs = list(),
  ...
)

Arguments

object

an object of class crr2

conf.int

the level for a two-sided confidence interval on the coeficients; default is 0.95

n

logical; if TRUE, the sample size and number of events for each variable are added to the summary

ref

logical; if TRUE, rows with reference categories are added to results

html

logical; if TRUE, an htmlTable will be returned; otherwise, a matrix

combine_ci

logical; if FALSE, upper and lower confidence limits will be returned as separate columns; otherwise, an interval string will be returned

digits

number of digits past the decimal point to keep

format_p

logical; if TRUE, p-values will be formatted; otherwise, p-values will only be rounded

color_p

logical; if TRUE, p-values will be formatted and colored based on significance level; see cmprsk2:::color_pval

format_n

logical; if TRUE, for html = TRUE the total n is added for each total/events column and percents of total and events are shown in each row

htmlArgs

for html = TRUE, a named list of arguments passed to htmlTable for additional formatting or to override defaults

...

ignored

See Also

crr2; print.crr2

Examples

crrs <- crr2(Surv(futime, event(censored) == death) ~ age + sex + abo,
             data = transplant)
summary(crrs)

summary(crrs, conf.int = 0.9, digits = 3L,
        combine_ci = TRUE, format_p = TRUE)

library('htmlTable')
summary(crrs, html = TRUE, combine_ci = TRUE, n = TRUE)

summary(
  crrs, html = TRUE, combine_ci = TRUE, n = TRUE, ref = TRUE,
  htmlArgs = list(
    caption = 'CRR models.', rgroup = c('Age', 'Sex', 'Blood type'),
    rnames = c('+1 year change', 'Female', 'B', 'AB', 'O')
  )
)


raredd/cmprsk2 documentation built on March 29, 2024, 5:34 a.m.