ufs (version 0.5.12)

formatCI: Pretty formatting of confidence intervals

Description

Pretty formatting of confidence intervals

Usage

formatCI(
  ci,
  sep = "; ",
  prefix = "[",
  suffix = "]",
  digits = 2,
  noZero = FALSE
)

Value

A character vector of one element.

Arguments

ci

A confidence interval (a vector of 2 elements; longer vectors work, but I guess that wouldn't make sense).

sep

The separator of the values, usually "; " or ", ".

prefix, suffix

The prefix and suffix, usually a type of opening and closing parenthesis/bracket.

digits

The number of digits to which to round the values.

noZero

Whether to strip the leading zero (before the decimal point), as is typically done when following APA style and displaying correlations, p values, and other numbers that cannot reach 1 or more.

See Also

noZero(), formatR(), formatPvalue()

Examples

### With leading zero ...
formatCI(c(0.55, 0.021));

### ... and without
formatCI(c(0.55, 0.021), noZero=TRUE);