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.
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:
interpret_superiority()
interpret_noninferiority()
interpret_equivalence()
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")
This is a basic example which shows you how to solve a common problem:
# Set up a dummy confidence intervalci_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)
confinterpret()
now returns an object of class `interpretation_result.interpretation_set
object that were used to generate them (previous versions just included the name of the interpretation_set
).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.interpretation_result
objects. See ?plot_interpretation_result_list
.interval_type = "unif"
.)interpretation_set
objects.interpretation_result
objects.plot.interpretation_set()
function - now takes account of length of extra_boundaries
names when setting the bottom margin.interpretation_set
some of the functions use).interpret_superiority()
, interpret_noninferiority()
, and interpret_equivalence()
.interpretation_set
objects.interpret_superiority()
, interpret_noninferiority()
, and interpret_equivalence()
.NB: v0.1.0 was accepted on CRAN (2017-03-15): https://CRAN.R-project.org/package=confinterpret
NEWS.md
file to track changes to the package.