R/examples.R

In stevethemes: Steve's 'ggplot2' Themes and Related Theme Elements

#' Create an example plot (in \pkg{ggplot2}) for experimenting with different styles
#'
#' @description \code{example_plot()} allows you to experiment with some
#' \pkg{ggplot2} themes, like those in this package, by seeing them applied to
#' some example plots.
#'
#' @details I'll add more here in a little bit.
#'
#' @name example_plot
#'
#' @param type a type
#'
#' @return \code{example_plot()} returns a plot made in \pkg{ggplot2}, allowing
#' the user to experiment with different themes to see which ones they like the
#' best.
#'
#' @author Steven V. Miller
#'
#' @examples
#'
#' library(ggplot2)
#'
#' example_plot()
#'
#' example_plot(type = "faceted_line")
#'
#' example_plot(type = "scatter")
#'
example_plot <- function(type = "bar") {

  if(type == "bar") {
    ggplot(martel_ratings, aes(as.factor(.data$value))) +
      labs(title = "A Bar Chart of CAGEMATCH Ratings for Rick Martel",
           x = "Rating on 1-10 Scale", y ="Count",
           caption = "Data: CAGEMATCH, the Internet Wrestling Database. Data are for illustration purposes, though Rick Martel is an objective 10/10.",
           subtitle = "This is just a simple bar chart. Experiment with customization options!") +
      geom_bar(fill=g_c("martel_eau"), alpha=.9, color='black') -> p

  } else if (type == "faceted_line") {

    ggplot(se_counties_gdppc, aes(.data$year, .data$value)) +
      geom_line() +
      facet_wrap(~county) +
      labs(title = "The GDP per Capita of Swedish Counties, 2001-2020",
           subtitle = "This is just a simple faceted line chart. Experiment with customization options!",
           y = "GDP per Capita (Nominal SEK)",
           x = "Year",
           caption = "Data: OECD") -> p


  } else if (type == "scatter") {
    ggplot(kwh_gdp, aes(.data$ln_kwhpc, .data$ln_gdppc)) +
      geom_smooth(method='lm', color=g_c("su_blue"), fill=g_c("martel_pink")) + geom_point(alpha=.8) +
      labs(title = "Energy Consumption per Capita and GDP per Capita, 2010",
           subtitle = "This is just a simple scatterplot. Experiment with customization options!",
           y = "GDP per Capita (Current USD, Logged)",
           x = "Kilowatt Hours per Capita (Logged)",
           caption = "Data: World Bank, OECD, and International Energy Agency") -> p
  }

  return(p)
}