Descriptive Interpretations of Confidence Intervals

Produces descriptive interpretations of confidence intervals. Includes (extensible) support for various test types, specified as sets of interpretations dependent on where the lower and upper confidence limits sit. Provides plotting functions for graphical display of interpretations.


Travis-CI Build Status CRAN_Status_Badge

An R package for interpreting confidence intervals.

The goal of confinterpret is to allow users to produce standardised descriptive interpretations from confidence intervals in R. The package supports researchers to focus more on generating estimates with associated ranges of uncertainty, rather than on single point-estimates, such as are common when conclusions are drawn from p-values.

The package includes (extensible) support for various test types, which are specified as sets of interpretations dependent on where the lower and upper confidence limits sit.

A collection of interpretation_set objects are provided in the package, to cover certain common situations where the confidence interval is of an effect size comparing two groups. Convenience / wrapper functions are provided for using each of these:

  • Superiority tests: interpret_superiority()
  • Non-inferiority tests: interpret_noninferiority()
  • Equivalence tests: interpret_equivalence()

Installation

confinterpret is on CRAN, so you can install it in the normal way:

install.packages("confinterpret")

You can also install the development version of confinterpret from github with:

# install.packages("devtools")
devtools::install_github("jimvine/confinterpret")

Example

This is a basic example which shows you how to solve a common problem:

# Set up a dummy confidence interval
ci_above <- matrix(c(0.15, 0.25), nrow = 1,
                   dimnames = list("estimate", c("2.5 %","97.5 %")))
 
ci_above_sup <- interpret_superiority(ci_above)
 
# Access the short-form interpretation:
ci_above_sup$interpretation_short
 
# Access the full interpretation:
ci_above_sup$interpretation
 
# Access the full interpretation, marked up with markdown:
ci_above_sup$interpretation_md
 
# Plot a chart of the interpretation (specify a nice colour-scheme first):
grDevices::palette(c("#FF671F99", "#F2A90099", "#0085CA99"))
plot(ci_above_sup)

News

confinterpret 1.0.0

S3 class for interpretation_result

  • The output of confinterpret() now returns an object of class `interpretation_result.
  • These results now include the interpretation_set object that were used to generate them (previous versions just included the name of the interpretation_set).

Plotting

  • Added plot method for interpretation_result objects. Plots the result on a chart, using the interpretation_set and associated parameters to draw a relevant canvas that shows the boundaries etc.
  • Added a plotting function that works for a collection of interpretation_result objects. See ?plot_interpretation_result_list.
  • All plotting functions support (and default to) drawing the intervals as curves rather than simple boxes. (Boxes can still be produced by specifying interval_type = "unif".)

Printing

  • Print method provided for interpretation_set objects.
  • Print method provided for interpretation_result objects.

confinterpret 0.2.0

Plotting

  • Improved plot.interpretation_set() function - now takes account of length of extra_boundaries names when setting the bottom margin.

Documentation

  • Corrections to help files (including errors in which interpretation_set some of the functions use).
  • Added examples to help files for interpret_superiority(), interpret_noninferiority(), and interpret_equivalence().
  • Added documentation on placeholders in supplied interpretation_set objects.
  • Added Value section to help files for interpret_superiority(), interpret_noninferiority(), and interpret_equivalence().

confinterpret 0.1.0

NB: v0.1.0 was accepted on CRAN (2017-03-15): https://CRAN.R-project.org/package=confinterpret

  • Initial version.
  • Added a NEWS.md file to track changes to the package.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("confinterpret")

1.0.0 by Jim Vine, 2 years ago


https://github.com/jimvine/confinterpret


Report a bug at https://github.com/jimvine/confinterpret/issues


Browse source code at https://github.com/cran/confinterpret


Authors: Jim Vine [aut, cre]


Documentation:   PDF Manual  


AGPL-3 license


Suggests graphics, grDevices, testthat


See at CRAN