riskdiff (version 0.2.1)

format_risk_diff: Format Risk Difference Results for Display

Description

Formats numerical values in risk difference results for presentation, with appropriate percentage formatting and rounding. Enhanced for v0.2.1 to handle boundary information and quality indicators with robust error handling.

Usage

format_risk_diff(
  results,
  digits = 2,
  p_accuracy = 0.001,
  show_ci_method = FALSE,
  show_quality = TRUE
)

Value

Tibble with additional formatted columns including:

rd_formatted

Risk difference as formatted percentage string

ci_formatted

Confidence interval as formatted string

p_value_formatted

P-value with appropriate precision

quality_indicator

Quality assessment (if show_quality = TRUE)

ci_method_display

CI method information (if show_ci_method = TRUE)

Arguments

results

Results tibble from calc_risk_diff()

digits

Number of decimal places for percentages (default: 2)

p_accuracy

Accuracy for p-values (default: 0.001)

show_ci_method

Logical indicating whether to show CI method in output (default: FALSE)

show_quality

Logical indicating whether to add quality indicators (default: TRUE)

Examples

data(cachar_sample)
results <- calc_risk_diff(cachar_sample, "abnormal_screen", "areca_nut")
formatted <- format_risk_diff(results)
print(formatted)

# Show CI methods and quality indicators
formatted_detailed <- format_risk_diff(results, show_ci_method = TRUE, show_quality = TRUE)
print(formatted_detailed)

# Customize formatting
formatted_custom <- format_risk_diff(results, digits = 3, p_accuracy = 0.01, show_quality = FALSE)
print(formatted_custom)