R/pam-plot.R

In davidallen02/pamngr: Private Asset Management, Inc. Data Tools

#' Creates a PAM formatted ggplot object
#'
#' @param p a ggplot object
#' @param x_lab string
#' @param y_lab string
#' @param plot_title string
#' @param plot_subtitle string
#' @param caption logical
#' @param axis_titles logical
#' @param y_format string
#' @param show_legend logical
#' @param faceted string
#'
#' @return a ggplot object
#' @export
#'
#'
pam_plot <- function(p,
                     x_lab = NA,
                     y_lab = NA,
                     plot_title = NA,
                     plot_subtitle = NA,
                     caption = TRUE,
                     axis_titles = FALSE,
                     y_format = "comma",
                     show_legend = TRUE,
                     faceted = NA){

  # Plot title ------------------------------------------------------------------------

  if(is.na(plot_title)){
    p <- p + ggplot2::theme(plot.title = ggplot2::element_blank())
  } else {
    p <- p + ggplot2::labs(title = plot_title)
  }

  # Plot subtitle ---------------------------------------------------------------------

  if(is.na(plot_subtitle)){
    p <- p + ggplot2::theme(plot.subtitle = ggplot2::element_blank())
  } else {
    p <- p + ggplot2::labs(subtitle = plot_subtitle)
  }


  # Caption ---------------------------------------------------------------------------

  if(caption){
    p <- p + ggplot2::labs(
      caption = paste('Created', format(Sys.Date(), '%B %d, %Y'))
    )
  }

  if(!caption){
    p <- p + ggplot2::theme(plot.caption = ggplot2::element_blank())
  }


  # Legend ----------------------------------------------------------------------------

  if(show_legend){
    p <- p +
      ggplot2::theme(
        legend.position = 'bottom',
        legend.title    = ggplot2::element_blank()
      )
  } else {p <- p + ggplot2::theme(legend.position = 'none')}


  # Axis titles -----------------------------------------------------------------------

  if(isFALSE(axis_titles)){
    p <- p + ggplot2::labs(x = NULL, y = NULL)
  } else {p <- p + ggplot2::labs(x = x_lab, y = y_lab)}


  # Axis text -------------------------------------------------------------------------
  if(y_format == "comma"){p <- p + ggplot2::scale_y_continuous(labels = scales::comma)}


  return(p)
}