R/add_labels.R

In jazznbass/scplot: Plot Function for Single-Case Data Frames

#' Add value labels to an scplot
#'
#' @inheritParams .inherit_scplot
#' @param nudge_y Offset on the y-axis.
#' @param nudge_x Offset on the x-axis.
#' @param round Number of digits of the labels.
#' @param padding Padding size around text.
#' @return An object of class `scplot` (see[scplot()]) with added/changed element
#'   `labels`.
#' @export
add_labels <- function(object,
                       nudge_y = 5,
                       nudge_x = 0,
                       round = NULL,
                       text = list(),
                       background = list(),
                       variable = ".dvar",
                       padding = NULL) {

  args_text <- text
  args_rect <- background

  if (is.null(padding)) padding <- object$theme$label.padding

  new <- list(
    variable = variable,
    nudge_x = nudge_x,
    nudge_y = nudge_y,
    round = round,
    padding = padding,
    text = .merge_element(args_text, object$theme$label.text),
    background = .merge_element(args_rect, object$theme$label.background)
  )
  object$labels <- c(
    object$label,
    list(new)
  )

  object
}