write_descv_plots: Write descriptive plots

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

Write descriptive plots

Description

write_descv_plots() is a Write function that writes a file to a specified local directory. Specifically, this function implements an algorithm to write descriptive plots. The function returns Descriptive plots paths (a list).

Usage

write_descv_plots(
  data_tb,
  ds_descvs_ls,
  descv_outp_dir_1L_chr,
  combined_plot_params_ls = list(nrow_1L_int = 2L, rel_heights_dbl = c(4, 10), scale_dbl
    = c(0.9, 0.9), base_height_dbl = 10),
  consent_1L_chr = "",
  consent_indcs_int = 1L,
  dim_plots_params_ls = list(plot_rows_cols_pair_int = c(3L, 2L), heights_int = c(10L,
    1L), width_1L_dbl = 8),
  item_plots_params_ls = list(plot_rows_cols_pair_int = c(5L, 4L), heights_int = c(10L,
    1L), width_1L_dbl = 9),
  lbl_nms_chr = character(0),
  maui_domains_pfxs_1L_chr = "vD",
  options_chr = c("Y", "N"),
  utl_by_rnd_plots_params_ls = list(width_1L_dbl = 6, height_1L_dbl = 4),
  x_labels_chr = character(0)
)

Arguments

data_tb	Data (a tibble)
ds_descvs_ls	Dataset descriptives (a list)
descv_outp_dir_1L_chr	Descriptive output directory (a character vector of length one)
combined_plot_params_ls	Combined plot parameters (a list), Default: list(nrow_1L_int = 2L, rel_heights_dbl = c(4, 10), scale_dbl = c(0.9, 0.9), base_height_dbl = 10)
consent_1L_chr	Consent (a character vector of length one), Default: ”
consent_indcs_int	Consent indices (an integer vector), Default: 1
dim_plots_params_ls	Dimension plots parameters (a list), Default: list(plot_rows_cols_pair_int = c(3L, 2L), heights_int = c(10L, 1L), width_1L_dbl = 8)
item_plots_params_ls	Item plots parameters (a list), Default: list(plot_rows_cols_pair_int = c(5L, 4L), heights_int = c(10L, 1L), width_1L_dbl = 9)
lbl_nms_chr	Label names (a character vector), Default: character(0)
maui_domains_pfxs_1L_chr	Multi-attribute utility instrument domains prefixes (a character vector of length one), Default: 'vD'
options_chr	Options (a character vector), Default: c("Y", "N")
utl_by_rnd_plots_params_ls	Utility by round plots parameters (a list), Default: list(width_1L_dbl = 6, height_1L_dbl = 4)
x_labels_chr	X labels (a character vector), Default: character(0)

Value

Descriptive plots paths (a list)

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