R/plot.simulation.R

In aumath-advancedr2019/ACM_2019: Monte Carlo methods

#' plot.simulation
#' 
#' @param x A result vector from a simulation algorithm
#' @param ggplot A boolean variable, determining if to use ggplot, directly from function call, rather than using control input
#' @return A plot of the summary of the input vector, containing mean, variance, relative error and confidence interval
#' 
#' @examples 
#' x <- MC_pi
#' plot(x)
#' 
#' @export
plot.simulation <- function(x, ggplot = FALSE){

  summ <- summary(x, print = F)
  my_mean <- summ$Mean
  my_REL <- summ$`Relative Error`
  lower <- my_mean*(1-my_REL)
  upper <- my_mean*(1+my_REL)
  
  if(ggplot == T){
    y <- data.frame(
      ones <- c(1,1,1),
      values = c(my_mean, lower, upper),
      is_mean = c(1,0,0)
    )
    
    ggplot2::ggplot(data = y, ggplot2::aes(x = ones, y = values, color = is_mean)) +
      ggplot2::geom_point() + 
      ggplot2::theme_classic() +
      ggplot2::theme(legend.position = "none",
                     axis.text.x=ggplot2::element_blank(),
                     axis.ticks.x=ggplot2::element_blank()) + 
      ggplot2::ylab('Value') +
      ggplot2::xlab("Simulation") 
  }else{
    ans <- 0
    if("ggplot2" %in% rownames(installed.packages()) && "gridExtra" %in% rownames(installed.packages())){
      ans <- menu(c("Yes", "No"), title="Do you want to use ggplot for plotting?")
    } 
    if(ans == 1){
      y <- data.frame(
        ones <- c(1,1,1),
        values = c(my_mean, lower, upper),
        is_mean = c(1,0,0)
      )
      
      ggplot2::ggplot(data = y, ggplot2::aes(x = ones, y = values, color = is_mean)) +
        ggplot2::geom_point() + 
        ggplot2::theme_classic() +
        ggplot2::theme(legend.position = "none",
                       axis.text.x=ggplot2::element_blank(),
                       axis.ticks.x=ggplot2::element_blank()) + 
        ggplot2::ylab('Value') +
        ggplot2::xlab("Simulation")
    } else{
      plot(1, my_mean, ylim = c(lower*(1-my_REL), upper*(1+my_REL)), xaxt = 'n')
      points(c(1,1), c(lower,upper), col = 'blue')
    }
  }
}