print_descv_stats_tbl: Print descriptive statistics table

In ready4-dev/youthvars: Describe and Validate Youth Mental Health Economic Datasets

Print descriptive statistics table

Description

print_descv_stats_tbl() is a Print function that prints output to console. Specifically, this function implements an algorithm to print descriptive statistics table. The function is called for its side effects and does not return a value.

Usage

print_descv_stats_tbl(
  df,
  data_tb,
  output_type_1L_chr,
  round_var_nm_1L_chr,
  variable_nms_chr,
  bl_fup_vals_chr = c("Baseline", "Follow-up"),
  capitalise_1L_lgl = T,
  caption_1L_chr = NULL,
  header_col_nms_chr = NULL,
  mkdn_tbl_ref_1L_chr = NULL,
  scroll_box_args_ls = NULL,
  test_1L_lgl = F,
  ...
)

Arguments

df	Data.frame (a data.frame)
data_tb	Data (a tibble)
output_type_1L_chr	Output type (a character vector of length one)
round_var_nm_1L_chr	Round variable name (a character vector of length one)
variable_nms_chr	Variable names (a character vector)
bl_fup_vals_chr	Baseline follow-up values (a character vector), Default: c("Baseline", "Follow-up")
capitalise_1L_lgl	Capitalise (a logical vector of length one), Default: T
caption_1L_chr	Caption (a character vector of length one), Default: NULL
header_col_nms_chr	Header column names (a character vector), Default: NULL
mkdn_tbl_ref_1L_chr	Markdown table reference (a character vector of length one), Default: NULL
scroll_box_args_ls	Scroll box arguments (a list), Default: NULL
test_1L_lgl	Test (a logical vector of length one), Default: F
...	Additional arguments

Value

No return value, called for side effects.

ready4-dev/youthvars documentation built on Nov. 15, 2024, 6:02 a.m.