R/multiplot.R

In ricoderks/Rcpm: General functions for the Center of Proteomics and Metabolomics (LUMC)

#' @title Multiple plot function (Deprecated)
#'
#' @description Put multiple graphs on one page.
#'
#' @param ... optionally ggplot objects
#' @param plotlist  list of ggplots
#' @param cols number of columns in layout
#' @param layout a matrix specifying the layout. If present, \code{cols} is ignored. See for more info Details
#'
#' @return One big graph containing multiple ggplot graphs.
#' 
#' @details ggplot objects can be passed in ..., or to plotlist (as a list of ggplot objects) 
#' If the layout is something like matrix(c(1, 2, 3, 3), nrow = 2, byrow = TRUE), then plot 1 will go in the upper left, 2 will go in the upper right, and 
#' 3 will go all the way across the bottom.
#' 
#' @export
#' @importFrom grid grid.newpage pushViewport viewport grid.layout
#'
#' @author Rico Derks
#' @references http://www.cookbook-r.com/Graphs/Multiple_graphs_on_one_page_(ggplot2)/
multiplot <- function(..., plotlist = NULL, cols = 1, layout = NULL) {
  .Deprecated(
    new = "",
    package = "Rcpm",
    msg = "The function multiplot is deprecated. There are much nicer solutions! Have a look at the package: patchwork."
  )
 # Make a list from the ... arguments and plotlist
  plots <- c(list(...), plotlist)

  numPlots = length(plots)

  # If layout is NULL, then use 'cols' to determine layout
  if (is.null(layout)) {
    # Make the panel
    # ncol: Number of columns of plots
    # nrow: Number of rows needed, calculated from # of cols
    layout <- matrix(seq(1, cols * ceiling(numPlots/cols)),
                     ncol = cols, 
                     nrow = ceiling(numPlots/cols))
  }

  if (numPlots == 1) {
    print(plots[[1]])

  } else {
    # Set up the page
    grid::grid.newpage()
    grid::pushViewport(grid::viewport(layout = grid::grid.layout(nrow(layout), ncol(layout))))

    # Make each plot, in the correct location
    for (i in 1:numPlots) {
      # Get the i,j matrix positions of the regions that contain this subplot
      matchidx <- as.data.frame(which(layout == i, arr.ind = TRUE))

      print(plots[[i]], vp = grid::viewport(layout.pos.row = matchidx$row,
                                      layout.pos.col = matchidx$col))
    }
  }
}