R/funnel_themes.R

In FunnelPlotR: Funnel Plots for Comparing Institutional Performance

#' A clean funnel plot theme
#' @description A ggplot theme function for clean looking funnel plots.
#' Try funnel_grey if you like the old one.
#' @return a list of ggplot theme items
#'
#' @seealso funnel_grey
#'
#' @importFrom ggplot2 theme_minimal theme_bw theme theme_grey
#' @export
#'
#' @examples
#'\dontrun{funnel_plot(theme=funnel_clean())}
funnel_clean <- function() {
  theme_minimal() %+replace%
    theme(legend.position = "bottom"
          , legend.text = element_text(size = 8)
          , legend.title = element_text(size = 8)
          , plot.title = element_text(size = 14, hjust = 0.5, face = "bold")
          , plot.subtitle = element_text(size = 10, hjust = 0.5
                                         , face = "italic"))
}


#' A grey ggplot funnel theme
#' @description A classic ggplot theme function for funnel plots.
#' Try funnel_clean if you don't like the grey background.
#' @return a list of ggplot theme items
#'
#' @seealso funnel_clean
#'
#' @importFrom ggplot2 theme_classic
#' @export
#'
#' @examples
#' \dontrun{funnel_plot(theme=funnel_grey())}
funnel_grey <- function() {
  theme_grey() %+replace%
    theme(legend.position = "bottom"
          , legend.text = element_text(size = 8)
          , legend.title = element_text(size = 8)
          , plot.title = element_text(size = 14, hjust = 0.5, face = "bold")
          , plot.subtitle =
            element_text(size = 10, hjust = 0.5, face = "italic"))
}