R/d3_bar.R

In KoderKow/B430-d3plot: Create D3 Visualizations

#' Bar plot made with D3
#'
#' @param data A Dataset to use for plotting. Should be a dataframe
#' @param x_var Attribute to place on the x axis
#' @param y_var Attribute for the y axis. If *y_var* is not specified or NULL, the *x_var* will be counted
#' @param title Title for the plot, placed above plot
#' @param x_lab X axis label. Default is *x_var's* object name
#' @param y_lab Y axis label. Default is *y_var's* ovject name
#' @param color Color of the bars. This value can be a hex color, color name, or the column name from the dataframe
#' @param border Color of the border of the bars
#' @param opacity transparency level
#' @param transition_duration Duration for the bars to transtion
#'
#' @return An HTML widget that displays a bar plot made with D3.js
#' @export
#'
#' @import dplyr
#' @import rlang
#' @importFrom r2d3 r2d3
#'
#' @examples
#' # not run:
#' # d3_bar(mtcars, am)
d3_bar <- function (data, x_var, y_var = NULL, title = NULL, x_lab = NULL, y_lab = NULL, color = "black", border = NULL, opacity = 1, transition_duration = 0) {

  x_quo <- rlang::enquo(x_var)
  y_quo <- rlang::enquo(y_var)

  x_name <- rlang::quo_name(rlang::enquo(x_var))
  y_name <- rlang::quo_name(rlang::enquo(y_var))
  x_group <- rlang::quo(!!rlang::sym(x_name))

  if (is.null(x_lab)) x_lab <- x_name

  if (is.null(y_var)) {
    tmp <- data %>%
      dplyr::count(!!x_group) %>%
      dplyr::mutate(
        x = !!x_group,
        y = n
      )
  } else {
    tmp <- data %>%
      dplyr::rename(x = !!x_quo, y = !!y_quo)
  }

  r2d3::r2d3(data = tmp,
       script = system.file("d3_bar.js", package = "d3plot"),
       options = list(x_name = x_name,
                      y_name = y_name,
                      title = list(title = title),
                      xaxis = list(title = x_lab),
                      yaxis = list(title = y_lab),
                      bar = list(color = color,
                                 border = border,
                                 opacity = opacity),
                      transition_duration = transition_duration))
}