Nothing
#' @rdname ceplane.plot
#'
#' @template args-he
#' @param comparison Selects the comparator, in case of more than two
#' interventions being analysed. Default as `NULL` plots all the
#' comparisons together. Any subset of the possible comparisons can be selected
#' (e.g., `comparison = c(1,3)` or `comparison = 2`).
#' @param wtp The value of the willingness to pay parameter. Not used if
#' `graph = "base"` for multiple comparisons.
#' @param pos Parameter to set the position of the legend; for a single
#' comparison plot, the ICER legend position. Can be given in form of a string
#' `(bottom|top)(right|left)` for base graphics and
#' `bottom|top|left|right` for \pkg{ggplot2}. It can be a two-elements vector,
#' which specifies the relative position on the x and y axis respectively, or
#' alternatively it can be in form of a logical variable, with `FALSE`
#' indicating to use the default position and `TRUE` to place it on the
#' bottom of the plot. Default value is `c(1,1)`, that is the topright
#' corner inside the plot area.
#' @param graph A string used to select the graphical engine to use for
#' plotting. Should (partial-) match the two options `"base"` or
#' `"ggplot2"`. Default value is `"base"`.
#' @param ... If `graph = "ggplot2"` and a named theme object is supplied,
#' it will be passed to the \pkg{ggplot2} object. The usual ggplot2 syntax is used.
#' Additional graphical arguments:
#' \itemize{
#' \item `label.pos = FALSE`: will place the willingness to pay label in a
#' different position at the bottom of the graph - base and \pkg{ggplot2} only (no
#' label in \pkg{plotly}).
#' \item `line = list(color)`: a colour specifying the colour of the willingness-to-pay line.
#' \item `point = list(color)`: a vector of colours specifying the colour(s) associated
#' to the cloud of points. Should be of length 1 or equal to the number of comparisons.
#' \item `point = list(size)`: a vector of colours specifying the size(s) of the points.
#' Should be of length 1 or equal to the number of comparisons.
#' \item `point = list(shape)`: a vector of shapes specifying type(s) of the points.
#' Should be of length 1 or equal to the number of comparisons.
#' \item `icer = list(color)`: a vector of colours specifying the colour(s) of the ICER
#' points. Should be of length 1 or equal to the number of comparisons.
#' \item `icer = list(size)`: a vector of colours specifying the size(s) of the ICER
#' points. Should be of length 1 or equal to the number of comparisons.
#' \item `area_include`: logical, include or exclude the cost-effectiveness
#' acceptability area (default is TRUE).
#' \item `area = list(color)`: a colour specifying the colour of the cost-effectiveness
#' acceptability area.
#' \item `currency`: Currency prefix to cost differential values - \pkg{ggplot2} only.
#' \item `icer_annot`: Annotate each ICER point with text label - \pkg{ggplot2} only.
#' }
#'
#' @return If `graph = "ggplot2"` a ggplot object, or if `graph = "plotly"`
#' a plotly object containing the requested plot. Nothing is returned when
#' `graph = "base"`, the default.
#'
#' Grey dots show the simulated values for the joint
#' distribution of the effectiveness and cost differentials. The larger red
#' dot shows the ICER and the grey area identifies the sustainability area,
#' i.e. the part of the plan for which the simulated values are below the
#' willingness to pay threshold. The proportion of points in the sustainability
#' area effectively represents the CEAC for a given value of the willingness to
#' pay. If the comparators are more than 2 and no pairwise comparison is
#' specified, all scatterplots are graphed using different colours.
#'
#' @details In the \pkg{plotly} version, `point_colors`, `ICER_colors` and `area_color` can also
#' be specified as rgba colours using either the `[plotly]toRGB`
#' function or a rgba colour string, e.g. `'rgba(1, 1, 1, 1)'`.
#'
#' @author Gianluca Baio, Andrea Berardi
#' @seealso [bcea()],
#' [ceplane_plot_graph()]
#'
#' @references
#' \insertRef{Baio2011}{BCEA}
#'
#' \insertRef{Baio2013}{BCEA}
#'
#' @keywords hplot
#' @importFrom Rdpack reprompt
#' @export
#'
#' @examples
#' ## create the bcea object for the smoking cessation example
#' data(Smoking)
#'
#' m <- bcea(eff, cost, ref = 4, Kmax = 500, interventions = treats)
#'
#' ## produce the base plot
#' ceplane.plot(m, wtp = 200, graph = "base")
#'
#' ## select only one comparator
#' ceplane.plot(m, wtp = 200, graph = "base", comparison = 3)
#'
#' ## use ggplot2
#' if (requireNamespace("ggplot2")) {
#' ceplane.plot(m, wtp = 200, pos = "right", icer = list(size = 2), graph = "ggplot2")
#' }
#'
#' ## plotly
#' ceplane.plot(m, wtp = 200, graph = "plotly")
#' ceplane.plot(m, wtp = 200, comparison = 1, graph = "plotly")
#'
ceplane.plot.bcea <- function(he,
comparison = NULL,
wtp = 25000,
pos = c(0, 1),
graph = c("base", "ggplot2", "plotly"),
...) {
graph <- match.arg(graph)
he <- setComparisons(he, comparison)
graph_params <- prep_ceplane_params(he, wtp, ...)
if (is_baseplot(graph)) {
ceplane_plot_base(he,
wtp,
pos_legend = pos,
graph_params)
} else if (is_ggplot(graph)) {
ceplane_plot_ggplot(he,
wtp,
pos_legend = pos,
graph_params, ...)
} else if (is_plotly(graph)) {
ceplane_plot_plotly(he,
wtp,
graph_params,
pos_legend = pos)
}
}
#' Cost-effectiveness Plane Plot
#'
#' Produces a scatter plot of the cost-effectiveness plane,
#' together with the sustainability area, as a function of
#' the selected willingness to pay threshold.
#'
#' @template args-he
#'
#' @export
#' @aliases ceplane.plot
#'
ceplane.plot <- function(he, ...) {
UseMethod('ceplane.plot', he)
}
Any scripts or data that you put into this service are public.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.