tests_proptest: Performs Difference of Proportion Tests on a given dataset

In oislen/BuenaVista: Functions for Everyday Data Science Tasks

Description

Performs Difference of Proportion Tests on a given dataset The data can be a mixture of numric and factor variables. The results are outputed as a data frame. Furthermore the results an be saved as .csv file to a specified directory.

Usage

tests_proptest(dataset, y_index = NULL, y_name = NULL,
  alternative = c("two.sided", "greater", "less"), conf.level = 0.95,
  correct = TRUE, file_name = NULL, directory = NULL)

Arguments

dataset	A dataset on which the Difference of Proportion Tests are performed.
y_index	An integer value, the column index of the response variable, the default is NULL.
y_name	A character value, the column name of the response variable, the default is NULL.
alternative	The type of hypothesis being tested; two.sided, greater, less. The default is "two.sided"
conf.level	The level of confidence used in the Test, default is 0.95
correct	A logical object, indicating whether Yates' continuity correction should be applied where possible, default is TRUE.
file_name	A character object indicating the file name when saving the data frame. The default is NULL. The name must include the .csv suffixs.
directory	A character object specifying the directory where the data frame is to be saved as a .csv file. The default is NULL.

Value

Outputs the Difference of Proportion Tests information as a data frame.

See Also

tests_chisq, tests_cors, tests_ks, tests_norm, tests_t, tests_var, tests_wilcoxon

Examples

#-- Example Lung Cap Data --#

# perform difference of proportion tests on the entire dataset
tests_proptest(dataset = lungcap)

# perform a difference of proportion test in relation to the fifth column
tests_proptest(dataset = lungcap, y_index = 5)

# perform a difference of proportion test in relation to the gender column
tests_proptest(dataset = lungcap, y_name = "Gender")

oislen/BuenaVista documentation built on May 16, 2019, 8:12 p.m.