T_hss_write_formatted: Write formatted tables to a list for selected variables

In RenRMT/hsstools: Simplify the HSS Data Process

Write formatted tables to a list for selected variables

Description

Write formatted tables to a list for all variable/question names contained in a questions list. A question list for all questions in the current survey can be made with the T_hss_create_question_list function. This function silently skips any questions that cause errors during creation of the contingency table, labeling or formatting, and returns a list item of length NULL instead. This is useful to automatically omit any question variables that have been removed during data cleaning, but might in some cases lead to unexpected behavior. The list of flextables created with this function can be used as input for the T_hss_export_formatted function to write all tables to a .docx file.

Usage

T_hss_write_formatted(
  df,
  questions,
  group,
  dict,
  percent = TRUE,
  digits = 1,
  lang = "en"
)

Arguments

df	The dataframe containing relevant variables
questions	A named character vector containing variable names and the table type required.
group	The desired grouping/disaggregation variable.
percent	TRUE/FALSE if the table should be created with percentage values. If set to FALSE, counts are shown.
digits	The number of (significant) digits to display for percentages. Set to 1 by default.
lang	The language to use for labelling of questions and response options. Set to "en" for english by default. Can be set to "ar" for Arabic.

Value

A named list of flextable objects containing formatted contingency tables for the specified questions from the HSS.

See Also

T_hss_export_formatted, T_hss_create_question_list

RenRMT/hsstools documentation built on April 14, 2025, 7:10 p.m.