R/plot-dot-plot.R

In kueckelj/confuns: Convenience Functions

#' @title Plot 1d dot plot
#'
#' @description Plots a dot plot of one categorical variable. Numeric
#' values can be displayed via alpha, color, size and x-axis.
#'
#' @param x Character value. The numeric continuous varable.
#' @param y Charcter value. The grouping variable.
#' @inherit argument_dummy params
#'
#' @details A ggplot.
#'
#' @export

plot_dot_plot_1d <- function(df,
                             x,
                             y,
                             across = NULL,
                             across.subset = NULL,
                             relevel = TRUE,
                             reorder = TRUE,
                             reorder.rev = FALSE,
                             alpha.by = NULL,
                             alpha.trans = "identity",
                             color.by = NULL,
                             color.trans = "identity",
                             shape.by = NULL,
                             size.by = NULL,
                             size.trans = "reverse",
                             pt.alpha = 0.9,
                             pt.color = "black",
                             pt.clrp = "default",
                             pt.clrsp = "plasma",
                             pt.shape = 19,
                             pt.size = 3,
                             scales = "free_y",
                             nrow = NULL,
                             ncol = NULL,
                             transform.with = NULL,
                             ...){

  df <-
    transform_df(
      df = df,
      transform.with = transform.with,
      sep = "."
    )

  df <-
    check_across_subset2(
      df = df,
      across = across,
      across.subset = across.subset,
      relevel = relevel
    )

  if(base::isTRUE(reorder)){

    if(base::isTRUE(reorder.rev)){

      df <- dplyr::mutate(df, reorder_var = -!!rlang::sym(x))

    } else {

      df <- dplyr::mutate(df, reorder_var = !!rlang::sym(x))

    }

    df <-
      dplyr::group_by(df, !!rlang::sym(across)) %>%
      dplyr::mutate(
        {{y}} := tidytext::reorder_within(
          x = !!rlang::sym(y),
          by = reorder_var,
          within = !!rlang::sym(across)
        )
      )

    reorder_add_on <- tidytext::scale_y_reordered()

  } else {

    reorder_add_on <- NULL

  }

  facet_add_on <-
    make_facet_add_on(across = across, scales = scales, nrow = nrow, ncol = ncol)

  params <- adjust_ggplot_params(params = list(size = pt.size, color = pt.color, alpha = pt.alpha), sep = ".")

  ggplot2::ggplot(data = df, mapping = ggplot2::aes(x = .data[[x]], y = .data[[y]])) +
    ggplot2::layer(
      geom = "point",
      stat = "identity",
      position = "identity",
      mapping = ggplot2::aes_string(alpha = alpha.by, color = color.by, size = size.by),
      params = params
    ) +
    ggplot2::scale_alpha(trans = alpha.trans) +
    ggplot2::scale_size(trans = size.trans) +
    scale_color_add_on(
      aes = "color",
      variable = pull_var(df, color.by),
      clrp = pt.clrp,
      clrsp = pt.clrsp,
      color.trans = color.trans,
      ...) +
    ggplot2::theme_bw() +
    facet_add_on +
    reorder_add_on

}


#' @title Plot 2d dot plot
#'
#' @description Plots a dot plot of two categorical variables. Numeric
#' values can be displayed via alpha, color and size.
#'
#' @param arrange.y Logical. If TRUE the labels of \code{y} are arranged by
#' their appearances in the groups of \code{x}.
#' @param arrange.by Character value or NULL. If character, denotes the
#' numeric variable by which the labels of \code{y} are arranged within the
#' groups of \code{x}.
#' @param reverse.all Logical. If TRUE labels are displayed from bottom to top.
#' If FALSE, labels are displayed from top to bottom.
#' @param reverse.within Logical. If TRUE, labels are arranged within the
#' groups in a descending manner. If FALSE, labels are arranged within the
#' groups in an ascending manner. (regarding the numeric variables of \code{arrange.by}).
#'
#' @inherit argument_dummy params
#'
#' @return A ggplot.
#' @export
#'

plot_dot_plot_2d <- function(df,
                             x,
                             y,
                             alpha.by = NULL,
                             alpha.trans = "identity",
                             color.by = NULL,
                             color.trans = "identity",
                             shape.by = NULL,
                             size.by = NULL,
                             size.trans = "reverse",
                             pt.alpha = 0.9,
                             pt.color = "black",
                             pt.clrp = "default",
                             pt.clrsp = "plasma",
                             pt.shape = 19,
                             pt.size = 3,
                             transform.with = NULL,
                             arrange.y = FALSE,
                             arrange.by = NULL,
                             reverse.all = FALSE,
                             reverse.within = FALSE,
                             ...){

  check_data_frame(
    df = df,
    var.class = purrr::set_names(list("factor", "factor"), nm = c(x, y))
  )

  df <-
    transform_df(
      df = df,
      transform.with = transform.with,
      sep = "."
    )

  params <-
    adjust_ggplot_params(
      params = list(alpha = pt.alpha, color = pt.color, shape = pt.shape, size = pt.size),
      sep = "."
    )

  if((base::is.character(arrange.by) | base::isTRUE(reverse.all)) & base::isTRUE(arrange.y)){

    df <-
      arrange_axis(
        df = df,
        grouping.var = x,
        arrange.var = y,
        arrange.by = arrange.by,
        reverse.all = reverse.all,
        reverse.within = reverse.within
        )

  }

  ggplot2::ggplot(data = df, mapping = ggplot2::aes_string(x = x, y = y)) +
    ggplot2::layer(
      geom = "point",
      stat = "identity",
      position = "identity",
      params = params,
      mapping = ggplot2::aes_string(color = color.by, shape = shape.by, size = size.by)
    ) +
    ggplot2::scale_alpha(trans = alpha.trans) +
    ggplot2::scale_size(trans = size.trans) +
    scale_color_add_on(
      aes = "color",
      clrp = pt.clrp,
      clrsp = pt.clrsp,
      variable = df[[color.by]],
      color.trans = color.trans
    ) +
    ggplot2::theme_bw()

}