format_ci: Format an Estimate and Confidence Interval as Text

In inbo/effectclass: Classification and Visualisation of Effects

Format an Estimate and Confidence Interval as Text

Description

The function rounds the estimate, lower and upper confidence interval to the same magnitude. The magnitude shows the width of the confidence interval with two significant digits.

Usage

format_ci(
  estimate,
  se,
  lcl,
  ucl,
  interval = 0.95,
  link = c("identity", "log", "logit"),
  max_digit = 4,
  percent = FALSE,
  sign = FALSE,
  change = FALSE
)

Arguments

estimate	The estimate in the link scale.
se	The standard error in the link scale. If missing, you must provide values for lcl and ucl.
lcl	The lower confidence limit. Ignored when se is given.
ucl	The upper confidence limit. Ignored when se is given.
interval	The coverage of the confidence interval. Only used when se is given. Defaults to 0.95 (⁠95%⁠).
link	The transformation of estimate, se, lcl and ucl. The appropriate back transformation is applied before formatting.
max_digit	The maximum number of significant digits to display. Defaults to 4.
percent	Display the interval as a percentage (= multiply by 100 and append ⁠%⁠). Defaults to FALSE.
sign	Always add the sign to the text. (e.g. +1 instead of 1). Defaults to FALSE.
change	Display interval as a change. Subtract 1 after applying the link and before applying percent. Use it to display ⁠0.9 (0.85; 0.95)⁠ as ⁠-10% (-15%; -5%)⁠. Defaults to FALSE. Implies sign == TRUE.

See Also

Other display functions: class_labels()

Examples

format_ci(0.512345, 1)
format_ci(0.512345, 1, interval = 0.9)
format_ci(0.512345, 1, link = "log")
format_ci(0.512345, 1, link = "logit")
format_ci(0.512345, 10)
format_ci(0.512345, 0.1)
format_ci(0.512345, 0.01)
format_ci(0.512345, 0.001)
format_ci(0.512345, 0.0001)
format_ci(0.512345, 0.00001)
format_ci(0.512345, 0.00001, max_digit = 10)
format_ci(0.512345, 0.5)
format_ci(-0.1, lcl = -0.1999, ucl = 0.1234)
format_ci(-0.1, lcl = -0.1999, ucl = 0.1234, percent = TRUE)
format_ci(-0.1, lcl = -0.1999, ucl = 0.1234, sign = TRUE)
format_ci(-0.1, lcl = -0.1999, ucl = 0.1234, percent = TRUE, sign = TRUE)
format_ci(-0.1, lcl = -0.1999, ucl = 0.1234)
format_ci(0.512345e-6, 1e-6)
format_ci(0.512345e-7, 1e-7)
format_ci(0.512345e-7, 1e-8)
format_ci(0.512345e-7, 1e-9)
format_ci(0.512345, 0.1, link = "log", percent = TRUE, change = FALSE)
format_ci(0.512345, 0.1, link = "log", percent = TRUE, change = TRUE)
format_ci(0, lcl = 0, ucl = 0)
format_ci(1, lcl = 1, ucl = 1)

inbo/effectclass documentation built on June 8, 2024, 2:43 a.m.