Skip to contents

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

Usage

print_table(
  data_tb,
  mkdn_tbl_ref_1L_chr,
  add_to_row_ls = NULL,
  big_mark_1L_chr = " ",
  caption_1L_chr = NA_character_,
  digits_dbl = NULL,
  footnotes_chr = NA_character_,
  heading_grps_chr = NULL,
  hline_after_ls = NULL,
  inc_col_nms_1L_lgl = FALSE,
  inc_row_nms_1L_lgl = FALSE,
  merge_row_idx_int = NA_integer_,
  output_type_1L_chr = "PDF",
  sanitize_fn = getOption("xtable.sanitize.text.function", NULL),
  scroll_box_args_ls = NULL,
  use_lbls_as_col_nms_1L_lgl = F,
  use_rdocx_1L_lgl = F
)

Arguments

data_tb

Data (a tibble)

mkdn_tbl_ref_1L_chr

Markdown table reference (a character vector of length one)

add_to_row_ls

Add to row (a list), Default: NULL

big_mark_1L_chr

Big mark (a character vector of length one), Default: ' '

caption_1L_chr

Caption (a character vector of length one), Default: 'NA'

digits_dbl

Digits (a double vector), Default: NULL

footnotes_chr

Footnotes (a character vector), Default: 'NA'

heading_grps_chr

Heading groups (a character vector), Default: NULL

hline_after_ls

Horizonal line after (a list), Default: NULL

inc_col_nms_1L_lgl

Include column names (a logical vector of length one), Default: FALSE

inc_row_nms_1L_lgl

Include row names (a logical vector of length one), Default: FALSE

merge_row_idx_int

Merge row index (an integer vector), Default: NA

output_type_1L_chr

Output type (a character vector of length one), Default: 'PDF'

sanitize_fn

Sanitize (a function), Default: getOption("xtable.sanitize.text.function", NULL)

scroll_box_args_ls

Scroll box arguments (a list), Default: NULL

use_lbls_as_col_nms_1L_lgl

Use labels as column names (a logical vector of length one), Default: F

use_rdocx_1L_lgl

Use rdocx (a logical vector of length one), Default: F

Value

No return value, called for side effects.