R/print_plotSmooth.R

In mfasiolo/mgcViz: Visualisations for Generalized Additive Models

#'
#' Printing plots of smooth effects
#' 
#' @description This method prints objects of class \code{plotSmooth}.
#' @param x an object of class \code{plotSmooth}.
#' @param addLay if TRUE, and if the \code{$empty} slot of the \code{plotSmooth} object is TRUE
#'               or NULL, we add some default layers to the plots, before printing. Does not have
#'               any affect if the \code{plotSmooth} object already contains some layers (e.g. \code{l_rug()}).
#' @param ... currently unused.
#' @return Returns \code{NULL}, invisibly.
#' @name print.plotSmooth
#' @rdname print.plotSmooth
#' @export print.plotSmooth
#' @export
#' 
print.plotSmooth <- function(x, addLay = TRUE, ...) {
  
  # x is empty and we convert it to plotGam which will add layers
  if( is.null(x$empty) ) { x$empty <- TRUE }
  if( addLay && x$empty ) {  
    x  <- structure(list("plots" = list(x), "empty" = x$empty), 
                    "class" = c("plotGam", "gg"))
  } else { # No additional layers
    x <- x$ggObj
  }
  
  print(x) # Call either plot.plotGam or plot.ggplot
  
  return( invisible(NULL) )
  
}