formatCI: Pretty formatting of confidence intervals

In userfriendlyscience: Quantitative Analysis Made Accessible

Description

Pretty much does what the title says.

Usage

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

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	The prefix, usually a type of opening parenthesis/bracket.
suffix	The suffix, usually a type of 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.

Value

A character vector of one element.

Author(s)

Gjalt-Jorn Peters

Maintainer: Gjalt-Jorn Peters <[e-mail]>

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);

Example output

Registered S3 method overwritten by 'GGally':
  method from   
  +.gg   ggplot2
Registered S3 methods overwritten by 'lme4':
  method                          from
  cooks.distance.influence.merMod car 
  influence.merMod                car 
  dfbeta.influence.merMod         car 
  dfbetas.influence.merMod        car 
[1] "[0.55; 0.02]"
Registered S3 methods overwritten by 'ufs':
  method                     from               
  grid.draw.ggProportionPlot userfriendlyscience
  pander.associationMatrix   userfriendlyscience
  pander.dataShape           userfriendlyscience
  pander.descr               userfriendlyscience
  pander.normalityAssessment userfriendlyscience
  print.CramersV             userfriendlyscience
  print.associationMatrix    userfriendlyscience
  print.confIntOmegaSq       userfriendlyscience
  print.confIntV             userfriendlyscience
  print.dataShape            userfriendlyscience
  print.descr                userfriendlyscience
  print.ggProportionPlot     userfriendlyscience
  print.meanConfInt          userfriendlyscience
  print.multiVarFreq         userfriendlyscience
  print.normalityAssessment  userfriendlyscience
  print.regrInfluential      userfriendlyscience
  print.scaleDiagnosis       userfriendlyscience
  print.scaleStructure       userfriendlyscience
  print.scatterMatrix        userfriendlyscience
[1] "[.55; .02]"

userfriendlyscience documentation built on May 2, 2019, 1:09 p.m.