R/make_scatter.R

In livelihoods-and-landscapes/maplandscape: Shiny application to explore and visualise GeoPackage data

#' Scatter plot
#'
#' Generate and style a scatter plot from two numeric columns in a (spatial -
#' \href{https://r-spatial.github.io/sf/index.html}{sf}) data frame. Designed to
#' be used in a Shiny application to visualise the bivariate relationship between two variables.
#'
#' This is a helper function to pass user defined data, aesthetic mappings, and chart styling parameters to \link[ggplot2]{ggplot} within a Shiny app.
#'
#' @param chart_active_df data frame containing a column whose values will be
#'   used to generate a histogram.
#' @param scatter_x_var a single element character vector specifying the name of
#'   the column to use to plot on the X-axis.
#' @param scatter_y_var a single element character vector specifying the name of
#'   the column to use to plot on the Y-axis.
#' @param point point size.
#' @param x_lab a single element character vector specifying the X-axis label.
#' @param y_lab a single element character vector specifying the Y-axis label.
#' @param axis_font_size a numeric value specifying the font size for axis tick
#'   labels.
#' @param lab_font_size a numeric value specifying the font size for axis
#'   labels.
#'
#' @return a \link[ggplot2]{ggplot} object that can be passed to
#'   \link[Shiny]{renderPlot} to display in a Shiny application.
#'
#' @export
#'
make_scatter <- function(chart_active_df, scatter_x_var, scatter_y_var, point, x_lab, y_lab, axis_font_size, lab_font_size) {
  chart <-
    ggplot2::ggplot(
      chart_active_df,
      ggplot2::aes(.data[[scatter_x_var]], .data[[scatter_y_var]])
    ) +
    ggplot2::geom_point(color = "#593196", size = point) +
    ggplot2::xlab(x_lab) +
    ggplot2::ylab(y_lab) +
    ggplot2::theme(
      plot.background = ggplot2::element_rect(fill = NA, colour = NA),
      panel.background = ggplot2::element_rect(fill = NA, colour = "#17141f"),
      axis.text.x = ggplot2::element_text(
        angle = -45,
        vjust = 1,
        hjust = 0,
        size = axis_font_size
      ),
      axis.text.y = ggplot2::element_text(size = axis_font_size),
      axis.title.x = ggplot2::element_text(size = lab_font_size),
      axis.title.y = ggplot2::element_text(size = lab_font_size)
    )

  chart
}