ShowRegTable {tableone}

Format regression results in medically decent format

Description

It shows the regression result in the HR [95% CI] p-value format, which is usually the form used in medical research papers.

Usage

ShowRegTable(
  model,
  exp = TRUE,
  digits = 2,
  pDigits = 3,
  printToggle = TRUE,
  quote = FALSE,
  ciFun = confint
)

Arguments

model

Regression model result objects that have the summary and confint methods.

exp

TRUE by default. You need to specify exp = FALSE if your model is has the indentity link function (linear regression, etc).

digits

Number of digits to print for the main part.

pDigits

Number of digits to print for the p-values.

printToggle

Whether to print the output. If FALSE, no output is created, and a matrix is invisibly returned.

quote

Whether to show everything in quotes. The default is FALSE. If TRUE, everything including the row and column names are quoted so that you can copy it to Excel easily.

ciFun

Function used for calculation. confint is the default. For generalized linear models this gives the profile likelihood-based calculation, which may take too much time for large models, use confint.default for simple normal approximation method (+/- 1.96 * standard error).

Value

A matrix containing what you see is returned invisibly. You can capture it by assignment to an object.

Author(s)

Kazuki Yoshida

Examples

## Load
library(tableone)

## Load Mayo Clinic Primary Biliary Cirrhosis Data
library(survival)
data(pbc)
## Check variables
head(pbc)

## Fit a Cox regression model
objCoxph <- coxph(formula = Surv(time, status == 2) ~ trt + age + albumin + ascites,
                  data    = pbc)

## Show the simple table
ShowRegTable(objCoxph)

## Show with quote to ease copy and paste
ShowRegTable(objCoxph, quote = TRUE)