R/design_mytheme.R

In IOBR/IOBR: Immune Oncology Biological Research

#' design_mytheme
#'
#' @description This function modifies a ggplot2 theme based on user-defined parameters for various plot elements. It allows customization of the theme's appearance, including title size, axis size, legend position, and more.
#' @param plot_title_size The size of the plot title. Default is 2.
#' @param axis_title_size The size of the axis titles. Default is 2.
#' @param axis_text_size The size of the axis tick mark labels. Default is 12.
#' @param axis_angle  The angle of rotation for the x-axis tick mark labels. Default is 60.
#' @param legend.position The position of the legend in the plot. Options include "none", "left", "right", "bottom", and "top". Default is NULL.
#' @param legend.direction The direction of the legend items. Options include "horizontal" and "vertical". Default is NULL.
#' @param hjust horizontal justification
#' @param legend.size The size of the legend key. Default is 0.25.
#' @param theme The desired theme for the plot. Options include "light", "bw", "classic", and "classic2". Default is "light".
#' @param legend.size.text The size of the legend text labels. Default is 10.
#' @param legend.key.height The height of the legend key. Default is 0.5.
#' @param legend.key.width The width of the legend key. Default is 0.5.
#' @param legend.box The orientation of the legend box. Options include "horizontal" and "vertical". Default is "horizontal".
#'
#' @author Dongqiang Zeng
#' @return mytheme
#' @export
#'
#' @examples
#' mytheme <- design_mytheme()
design_mytheme<-function(theme            = "light",
                         plot_title_size  = 2,
                         axis_title_size  = 2,
                         axis_text_size   = 12,
                         axis_angle       = 60,
                         hjust            = 1,
                         legend.position  = NULL,
                         legend.direction = NULL,
                         legend.size      = 0.25,
                         legend.key.height= 0.5,
                         legend.key.width = 0.5,
                         legend.size.text = 10,
                         legend.box       = "horizontal"){

  if(theme=="light"){
    mytheme<-ggplot2::theme_light()
  }else if(theme=="bw"){
    mytheme<-ggplot2:: theme_bw()
  }else if(theme=="classic"){
    mytheme<-ggplot2:: theme_classic()
  }else if(theme=="classic2"){
    mytheme<-ggpubr:: theme_classic2()
  }
  message(paste0(">>>>Options for `theme`: light, bw, classic and classic2"))

  mytheme<-mytheme + ggplot2:: theme(plot.title=element_text(size=rel(plot_title_size),hjust=0.5),
                      axis.title=element_text(size=rel(axis_title_size)),
                      axis.text=element_text(size=rel(4)),
                      axis.text.x= element_text(face="plain",size= axis_text_size,
                                                angle=axis_angle,hjust = hjust,color="black"),#family="Times New Roman"
                      axis.text.y= element_text(face="plain",size= axis_text_size,color="black"),#family="Times New Roman"
                      # panel.grid.major=element_line(color="white"),
                      # panel.grid.minor=element_line(color="white"),
                      # panel.border=element_rect(color="white"),
                      axis.line=element_line(color="grey", size = 0.2))

  if(is.null(legend.position)) {
    legend.position<- "bottom"

  }else{

    message(paste0(">>>>Options for 'legend.position' : none, left, right, bottom, top"))
  }

  if(is.null(legend.direction)) {
    legend.direction<- "horizontal"
  }else{

    message(paste0(">>>>Options for 'legend.direction' : horizontal, vertical "))
  }


  mytheme<-mytheme+
    theme(
      # legend.key.size=unit(legend.size,"cm"),
      legend.key.height= unit(legend.key.height, 'cm'),
      legend.key.width= unit(legend.key.width, 'cm'),
      # legend.title=element_blank(),
      legend.position= legend.position,#"none","left","right","bottom","top",or #c(0.5,1)
      legend.direction= legend.direction,# "vertical"
      legend.justification=c(.5,.5),#"center" or two-element numeric vector
      legend.box= legend.box,#"horizontal",
      legend.box.just="top",
      legend.text=element_text(colour="black", size= legend.size.text, face = "plain")#("plain", "italic", "bold", "bold.italic")
    )

  return(mytheme)
}