R/plot.R

In nathansam/BenchJournal: Track Benchmark Results for a Package

#' @title Create interactive boxplots of benchmark results from journal.
#' @description Uses \code{ggplot2} and \code{plotly} to create boxplots for
#' each script in \code{man/BenchJournal/scripts} by date.
#' @param units The unit of time to use for the plot. Either 's' (seconds),
#'     'ms' (milliseconds), 'us' (microseconds), or 'ns' (nanoseconds).
#' @param rm.outliers Logical. If TRUE then outliers will not be included in the
#'     plot. Defaults to FALSE.
#' @export
JournalBoxPlot <- function(units = 's', rm.outliers = FALSE){
  test.date <- NULL
  time <- NULL
  journal <- utils::read.csv('man/BenchJournal/journal.csv')
  if (rm.outliers) journal <- RemoveOutliers(journal)
  scripts <- unique(as.character(journal$script))

  for (script in scripts){
    script.results <- subset(journal, script == script)

    if (units %in% c('s','ms','us','ns') == FALSE){
      stop ('Provided unit for time not an expected value')
    }

    if (units == 's') script.results$time <- script.results$time / 10^9
    if (units == 'ms') script.results$time <- script.results$time / 10^6
    if (units == 'us') script.results$time <- script.results$time / 10^3



    p <- ggplot2::ggplot(ggplot2::aes(x = test.date, y = time),
                         data = script.results)
    p <- p + ggplot2::geom_boxplot()
    p <- p + ggplot2::xlab('Package Version')
    p <- p + ggplot2::ylab(paste('Time (', units,')', sep = ""))
    p <- p + ggplot2::ggtitle(paste('Benchmark Results for ',
                                    script,
                                    ' (',
                                    GetPkgName(),
                                    ')',
                                    sep = "") )
    p <- p + ggplot2::theme_bw()



    p <- plotly::ggplotly(p)
    print (p)

  }

}