R/element-label-ylabel.R

In miyamot0/fxl: 'fxl' Single Case Design Charting Package

#' ylabel
#'
#' Override the y axis label
#'
#' @param core_frame fxl object
#' @param var string
#' @param color from base
#' @param cex from base
#' @param adj from base
#' @param face like 'font' from base
#' @param line line width
#'
#' @author Shawn Gilroy <sgilroy1@@lsu.edu>
#'
#' @returns nothing, run for side effects
#'
#' @export
scr_ylabel <- function(core_frame,
                       var,
                       color = "black",
                       cex = 1,
                       adj = 0.5,
                       face = 1,
                       line = 0) {

  assert_input_type({{ var }}, "character", "ylab")
  core_frame$labs[["ylab"]] <- {{ var }}

  assert_input_type(color, "character", "color")
  core_frame$labs[["ylab_color"]] <- color

  assert_input_type(cex, "numeric", "cex")
  core_frame$labs[["ylab_cex"]] <- cex

  assert_input_type(adj, "numeric", "adj")
  core_frame$labs[["ylab_adj"]] <- adj

  assert_input_type(face, "numeric", "face")
  core_frame$labs[["ylab_face"]] <- face

  isValidNumericVector(
    object = line,
    name = "line"
  )

  core_frame$labs[["outer.y.line"]] <- line

  core_frame
}