R/plotROC-package.R

In plotROC: Generate Useful ROC Curve Charts for Print and Interactive Use

#' Tools for plotting ROC Curves
#' 
#' Generate Useful ROC Curve Charts for Print and Interactive Use. This defines
#' a set of stats and geoms for use with ggplot2. In addition, ggplot objects
#' created with these geoms can be exported and turned into interactive plots
#' for use on the web. The interactive features include hovering to display
#' hidden labels, and clicking to reveal confidence regions.
#' 
#' To get started, see \link{geom_roc}, \link{geom_rocci}, or the examples
#' below. For transforming data, we also provide the convenience function
#' \link{melt_roc}.
#' 
#' The vignette contains some examples, along with explanations of the results. To view, run 
#' \code{vignette("examples", package = "plotROC")}
#' 
#' @examples 
#' 
#' D.ex <- rbinom(50, 1, .5)
#' rocdata <- data.frame(D = c(D.ex, D.ex), 
#'                    M = c(rnorm(50, mean = D.ex, sd = .4), rnorm(50, mean = D.ex, sd = 1)), 
#'                    Z = c(rep("A", 50), rep("B", 50)))
#' 
#' ggplot(rocdata, aes(m = M, d = D)) + geom_roc() + geom_rocci()
#' \donttest{
#' ggplot(rocdata, aes(m = M, d = D)) + geom_roc() + style_roc()
#' ggplot(rocdata, aes(m = M, d = D, color = Z)) + geom_roc() + geom_rocci()
#' ggplot(rocdata, aes(m = M, d = D, color = Z)) + geom_roc() + geom_rocci(sig.level = .01)
#' ggplot(rocdata, aes(m = M, d = D)) + geom_roc(n.cuts = 0) + 
#' geom_rocci(ci.at = quantile(rocdata$M, c(.1, .25, .5, .75, .9)))
#' ggplot(rocdata, aes(m = M, d = D, color = Z)) + geom_roc() + geom_rocci(linetype = 1)
#' 
#' rocplot <- ggplot(rocdata, aes(m = M, d = D)) + geom_roc()
#' 
#' plot_interactive_roc(rocplot)
#' plot_interactive_roc(rocplot + aes(color = Z))
#' plot_interactive_roc(rocplot + facet_wrap( ~ Z))
#' }
#' 
#' @name plotROC
#' @docType package
#' @author Michael Sachs (@@sachsmc)
#' @import ggplot2
#' @importFrom grid grobName grobTree unit.c grobHeight grobWidth viewport 
#'   grid.draw grobX grobY gTree gList rectGrob pointsGrob textGrob polylineGrob
#'   segmentsGrob nullGrob gpar
#' @importFrom rlang quo_name quo_get_expr
"_PACKAGE"