rbmiUtils (version 0.3.0)

format_results: Format Results for Reporting

Description

Formats a tidy results tibble for publication-ready reporting, with options for rounding, confidence interval formatting, and column selection.

Usage

format_results(
  results,
  digits = 2,
  ci_format = c("parens", "brackets", "dash"),
  pval_digits = 3,
  include_se = FALSE
)

Value

A tibble with formatted columns suitable for reporting.

Arguments

results

A tibble from tidy_pool_obj() or combine_results().

digits

Integer specifying the number of decimal places for estimates. Default is 2.

ci_format

Character string specifying CI format. Options are: "parens" for "(LCI, UCI)", "brackets" for "\[LCI, UCI\]", or "dash" for "LCI - UCI". Default is "parens".

pval_digits

Integer specifying decimal places for p-values. Default is 3.

include_se

Logical indicating whether to include standard error column. Default is FALSE.

See Also

• tidy_pool_obj() to create tidy results

• combine_results() to combine multiple analyses

Examples

# \donttest{
library(rbmi)

# Assuming you have a tidy result
# tidy_result <- tidy_pool_obj(pool_obj)
# formatted <- format_results(tidy_result, digits = 3, ci_format = "brackets")
# }