R/plot.EV.R

In BayesCombo: Bayesian Evidence Combination

#' @title Plot of posterior probabilities for each hypothesis
#'
#' @description Shows how the posterior probabilities evolve as each study is
#' added to the analysis.
#'
#' @details Each line in the graph is a hypothesis and the lines start at the
#' prior hypothesis probabilities (usually 1/3).
#'
#' @param x An object of the class \code{EV} created by the \code{ev.combo()}
#' function.
#' 
#' @param leg.loc Location of the legend; default is top left. See the
#' \code{legend()} help pages for all the options.
#' 
#' @param lty An vector of integers that specifies the line types. See the
#' \code{matplot()} function for details.
#' 
#' @param ... Other options passed to \code{matplot()}.
#'
#' @return Plot of posterior probabilities for each hypothesis.
#'
#' @seealso \code{\link{ev.combo}}
#'
#' @export
#'
#' @examples
#' x <- ev.combo(beta = c(0.0126, 5.0052, 1.2976, 0.0005),
#'        se.beta = c(0.050, 2.581, 2.054, 0.003) )
#' plot(x)

plot.EV <- function(x, leg.loc="topleft", lty=1, ...) {

    if (!inherits(x, "EV") ) {
        stop("Input must be a 'EV' object from the ev.combo() function.")
    }

    matplot(x$pphs, type="l", col=c("royalblue","darkgrey","firebrick"), lty=lty,
            lwd=c(1,3,1), ylim = c(0, 1), xaxt = "n", ...)
    axis(1, at = 1:(x$N+1), labels = 0:(x$N))

    legend(leg.loc, legend = c("H<", "H0", "H>"),
           fill = c("royalblue","darkgrey","firebrick"))
}