chisq: Pearson's chi-squared test

In vpnagraj/twoxtwo: Work with Two-by-Two Tables

Description

This function conducts a Pearson's chi-squared test for a twoxtwo constructed using the specified exposure and outcome. Internally the function uses chisq.test. The output of the function includes the chi-squared test statistic, degrees of freedom, and the p-value from the test.

Usage

chisq(.data, exposure, outcome, correct = TRUE, ...)

Arguments

.data	Either a data frame with observation-level exposure and outcome data or a twoxtwo object
exposure	Name of exposure variable; ignored if input to .data is a twoxtwo object
outcome	Name of outcome variable; ignored if input to .data is a twoxtwo object
correct	Logical as to whether or not to apply continuity correction; default is TRUE
...	Additional arguments passed to twoxtwo function; ignored if input to .data is a twoxtwo object

Value

A tibble with the following columns:

• test: Name of the test conducted

• estimate: Point estimate from the test (NA for chisq())

• ci_lower: The lower bound of the confidence interval for the estimate (NA for chisq())

• ci_upper: The upper bound of the confidence interval for the estimate (NA for chisq())

• statistic: Test statistic from the test

• df: Degrees of freedom parameter for the test statistic

• pvalue: P-value from the test

• exposure: Name of the exposure variable followed by +/- levels (e.g. smoking::yes/no)

• outcome: Name of the outcome variable followed by +/- levels (e.g. heart_disease::yes/no)

vpnagraj/twoxtwo documentation built on Nov. 3, 2021, 6:20 p.m.