tableone: Table One

View source: R/tableone.h.R

tableoneR Documentation

Table One

Description

This function generates a "Table One", a descriptive summary table frequently used in clinicopathological research manuscripts. It supports multiple output styles for flexible formatting.

Usage

tableone(data, vars, sty = "t1", excl = FALSE)

Arguments

data

The input data as a data frame.

vars

A set of variable names from data to include in the Table One. Supports numeric, ordinal, and categorical variables.

sty

Specify the output style for the table. Each option uses a different package for formatting.

excl

Boolean option to exclude missing values (NA) from the analysis. Note: Exclusion may remove entire cases.

Value

A results object containing:

results$todo a html
results$tablestyle1 a preformatted
results$tablestyle2 a html
results$tablestyle3 a html
results$tablestyle4 a html

Examples


# Example usage:
# data('histopathology')
# dat <- as.data.frame(histopathology)
# ClinicoPathDescriptives::tableone(
#   data = dat,
#   vars = vars(Sex, PreinvasiveComponent, LVI, PNI, Grade, Age),
#   sty = "t3",
#   excl = TRUE)


sbalci/ClinicoPathJamoviModule documentation built on Feb. 25, 2025, 6:34 a.m.