embed_cat_text_html {saros}

Creates a structured list with text interpretations for a set of variables.

Description

Creates a structured list with text interpretations for a set of variables.

Usage

embed_cat_text_html(
  data,
  dep = NULL,
  indep = NULL,
  ...,
  mesos_group = NULL,
  call = rlang::caller_env()
)

Arguments

data

Survey data

⁠obj:<data.frame>|obj:<tbl_df>⁠ // Required

A data frame (or a srvyr-object) with the columns specified in the chapter_overview 'dep_cat', etc columns.

dep, indep

Variable selections

<tidyselect> // Default: NULL, meaning everything for dep, nothing for indep.

Columns in data. Currently allows tidyselect-syntax, which will be removed.

...

Dynamic dots

<dynamic-dots>

Arguments forwarded to the corresponding functions that create the elements.

mesos_group

Specific group to compare with

⁠scalar<character>⁠ // Default: NULL (optional)

Both the absolute and relative folderpaths are required, as strings.

call

Internal call

⁠obj:<call>⁠ // Default: rlang::caller_env() (optional)

Both the absolute and relative folderpaths are required, as strings.

Value

List

Examples

embed_cat_text_html(ex_survey,
dep = tidyselect::matches("e_"),
contents = c("intro", "mode_max", "value_max",
"value_min", "not_used_category", "mean_max", "mean_min"),
label_separator = " - ",
require_common_categories = FALSE,
n_top_bottom = 1,
showNA = "never",
descend = TRUE,
return_raw = TRUE,
hide_label_if_prop_below=0,
data_label = "count",
data_label_decimal_symbol = ",",
digits = 1)