R/element-phasechange-multiple.R

Defines functions scr_plines_mbd

Documented in scr_plines_mbd

#' scr_plines_mbd
#'
#' @param core_frame fxl object
#' @param lines phase lines to be drawn
#' @param lty phase lines types
#'
#' @author Shawn Gilroy <sgilroy1@@lsu.edu>
#'
#' @returns a layer to the core plotting object
#'
#' @export
scr_plines_mbd <- function(core_frame,
                           lty = 1,
                           lines = NULL) {

  newlayer <- list()
  newlayer[["type"]] <- "mbd_phase_lines"

  newlayer[["lines"]] <- lines

  assert_input_type(lty, "numeric", "lty")
  newlayer[["lty"]] <- lty

  core_frame$layers[[(length(core_frame[["layers"]]) + 1)]] <- newlayer

  core_frame
}

Try the fxl package in your browser

Any scripts or data that you put into this service are public.

fxl documentation built on April 4, 2025, 3:31 a.m.