Description Usage Arguments Value
View source: R/statistic_functions.R
A method that generate description of factor variable and perform comparative statistic test in case of comparaison group.
1 2 3 4 5 6 7 8 9 10 11 12 13 |
data |
a data.frame containing the data to describe |
variable |
a character vector of length 1. The name of the factor column to describe. |
group |
a character vector of length 1. The name of the factor column to use as commparaison group. Default to NULL. |
group_str |
a character vector. The name of the levels of the group variable to use. Default to NULL. |
all |
a boolean. If TRUE, total column will be displayed. Default to FALSE |
round |
an integer, number of maximal decimal. Default to 3 |
p_value |
a boolean. If TRUE, comparaison test are performed. |
forcedTest |
a character vector of length 1. Must be one of "Pearson's Chi-squared test", "Pearson's Chi-squared test with Yates" or "Fisher's Exact Test for Count Data". Default to NULL. |
NA_group_AsModality |
a boolean. If TRUE, missing data of the group variable will be considered as levels. Default to FALSE |
NA_asModality |
a boolean. If TRUE, missing data of the factor variable to describe will be considered as levels. Default to FALSE |
output |
a data.frame, containing a previously generated data.frame or a new data.frame. data.frame are generated using createOutput() function. |
a data.frame containing the description of the factor variable
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.