Bind and Format Domain-Specific Tables

This function binds a named list of domain-specific tables, removes the domain column, highlights rows where \(E_{\text{Val_bound}}\) exceeds a specified threshold, and groups rows by domain using pack_rows. Advanced formatting features work with LaTeX or HTML output.

Usage

margot_bind_tables(
  tables_list,
  e_val_bound_threshold = 1,
  highlight_color = "yellow",
  bold = TRUE,
  output_format = "latex",
  rename_cols = TRUE,
  col_renames = list(`E-Value` = "E_Value", `E-Value bound` = "E_Val_bound"),
  threshold_col = "E_Val_bound",
  kbl_args = list(booktabs = TRUE, caption = "Combined Results by Domain")
)

Arguments

tables_list

A named list of data frames. Each element should represent a domain-specific table. The names of the list are used as domain labels.

e_val_bound_threshold

Numeric. Rows with E_Val_bound exceeding this threshold will be highlighted. Default is 1.

highlight_color

Character. The background highlight colour for output formats. Default is "yellow". Set to NULL to disable highlighting color.

bold

Logical. Whether to bold highlighted rows. For LaTeX this uses the bold parameter; for HTML, this is achieved with inline CSS. Default is TRUE.

output_format

Character. The output format passed to kbl(). Either "latex" or "html". Default is "latex".

rename_cols

Logical. Whether to rename columns using default renaming. Default is TRUE.

col_renames

Named list. Custom column renamings to apply. Format should be list("new_name" = "old_name"). Default renames "E_Value" to "E-Value" and "E_Val_bound" to "E-Value bound". Supply custom named list to override.

threshold_col

Character. The name of the column used for determining which rows to highlight. Default is "E_Val_bound". This should be the name of the column *before* any renaming is applied.

kbl_args

A list of additional arguments to pass to kbl(). For example, you might supply list(booktabs = TRUE, caption = "Combined Results by Domain").

Value

A formatted table (of class knitr_kable) with rows grouped by domain and highlighted where E_Val_bound exceeds the threshold.

Additional Notes

This function requires the kableExtra package to format tables. For LaTeX output, the booktabs package is recommended to be loaded in your LaTeX document.

See also

kbl for base table creation row_spec for row styling pack_rows for grouping rows rename for column renaming operations

Examples

if (FALSE) { # \dontrun{
tables_list <- list(
  Health = binary_results_health$transformed_table,
  Psych  = binary_results_psych$transformed_table,
  Life   = binary_results_life$transformed_table,
  Social = binary_results_social$transformed_table
)

# For LaTeX output:
margot_bind_tables(tables_list,
  output_format = "latex",
  e_val_bound_threshold = 1,
  bold = TRUE,
  kbl_args = list(booktabs = TRUE, caption = "Combined Results by Domain")
)

# For HTML output:
margot_bind_tables(tables_list,
  output_format = "html",
  e_val_bound_threshold = 1,
  highlight_color = "yellow",
  bold = TRUE,
  kbl_args = list(caption = "Combined Results by Domain")
)

# With custom column renaming:
margot_bind_tables(tables_list,
  output_format = "html",
  rename_cols = TRUE,
  col_renames = list("E-value (custom)" = "E_Value", "E-value bound (custom)" = "E_Val_bound")
)
} # }