des_summary_categorical {dataquieR} | R Documentation |
Compute Descriptive Statistics - categorical variables
Description
generates a descriptive overview of the categorical variables (nominal and
ordinal) in resp_vars
.
Usage
des_summary_categorical(
resp_vars = NULL,
study_data,
label_col,
item_level = "item_level",
meta_data = item_level,
meta_data_v2,
hard_limits_removal = getOption("dataquieR.des_summary_hard_lim_remove",
dataquieR.des_summary_hard_lim_remove_default),
...
)
Arguments
resp_vars |
variable the name of the categorical measurement variable |
study_data |
data.frame the data frame that contains the measurements |
label_col |
variable attribute the name of the column in the metadata with labels of variables |
item_level |
data.frame the data frame that contains metadata attributes of study data |
meta_data |
data.frame old name for |
meta_data_v2 |
character path to workbook like metadata file, see
|
hard_limits_removal |
logical if TRUE values outside hard limits are removed from the data before calculating descriptive statistics. The default is FALSE |
... |
arguments to be passed to all called indicator functions if applicable. |
Details
TODO
Value
a list with:
-
SummaryTable
: data.frame -
SummaryData
: data.frame
See Also
Examples
## Not run:
prep_load_workbook_like_file("meta_data_v2")
xx <- des_summary_categorical(study_data = "study_data", meta_data =
prep_get_data_frame("item_level"))
util_html_table(xx$SummaryData)
util_html_table(des_summary_categorical(study_data = prep_get_data_frame("study_data"),
meta_data = prep_get_data_frame("item_level"))$SummaryData)
## End(Not run)