svyCreateCatTable: Create an object summarizing categorical variables for...

Description Usage Arguments Value Author(s) See Also Examples

View source: R/svyCreateCatTable.R

Description

Create an object summarizing categorical variables optionally stratifying by one or more startifying variables and performing statistical tests. Usually, svyCreateTableOne should be used as the universal frontend for both continuous and categorical data.

Usage

1
2
svyCreateCatTable(vars, strata, data, includeNA = FALSE, test = TRUE,
  testApprox = svyTestChisq, argsApprox = NULL, smd = TRUE)

Arguments

vars

Variable(s) to be summarized given as a character vector.

strata

Stratifying (grouping) variable name(s) given as a character vector. If omitted, the overall results are returned.

data

A survey design object in which these variables exist. All variables (both vars and strata) must be in this survey design object. It is created with the svydesign function in the survey package.

includeNA

If TRUE, NA is handled as a regular factor level rather than missing. NA is shown as the last factor level in the table. Only effective for categorical variables.

test

If TRUE, as in the default and there are more than two groups, groupwise comparisons are performed. Both tests that require the large sample approximation and exact tests are performed. Either one of the result can be obtained from the print method.

testApprox

A function used to perform the large sample approximation based tests. The default is svychisq.

argsApprox

A named list of arguments passed to the function specified in testApprox.

smd

If TRUE, as in the default and there are more than two groups, standardized mean differences for all pairwise comparisons are calculated.

Value

An object of class svyCatTable.

Author(s)

Kazuki Yoshida

See Also

svyCreateTableOne, print.svyCatTable, summary.svyCatTable,

Examples

1
## See the examples for svyCreateTableOne()

tableone documentation built on June 20, 2017, 9:14 a.m.

Search within the tableone package
Search all R packages, documentation and source code