R/bm_call.R

In trevorld/bittermelon: Bitmap Tools

#' Execute a function call on bitmap objects
#'
#' `bm_call()` excutes a function call on bitmap objects.
#' Since its first argument is the bitmap object it is more
#' convenient to use with pipes then directly using [base::do.call()]
#' plus it is easier to specify additional arguments.
#' @inheritParams bm_clamp
#' @param .f A function to execute.
#' @param ... Additional arguments to `.f`.
#' @return The return value of `.f`.
#' @examples
#'   font_file <- system.file("fonts/spleen/spleen-8x16.hex.gz", package = "bittermelon")
#'   font <- read_hex(font_file)
#'   bml <- as_bm_list("RSTATS", font = font)
#'   bml <- bm_flip(bml, "both")
#'   bm <- bm_call(bml, cbind, direction = "RTL")
#'   print(bm)
#' @export
bm_call <- function(x, .f, ...) {
    if (!is.list(x))
        x <- list(x)
    l <- c(as.list(x), list(...))
    do.call(.f, l)
}