R/pin-delete.R

Defines functions pin_delete

Documented in pin_delete

#' Delete a pin
#'
#' Delete a pin (or pins), removing it from the board
#'
#' @inheritParams pin_read
#' @param names The names of one or more pins to delete
#' @export
#' @examples
#' board <- board_temp()
#' board %>% pin_write(1:5, "x")
#' board %>% pin_write(mtcars)
#' board %>% pin_write(runif(1e6), "y")
#' board %>% pin_list()
#'
#' board %>% pin_delete(c("x", "y"))
#' board %>% pin_list()
pin_delete <- function(board, names, ...) {
  ellipsis::check_dots_used(...)
  check_board(board, "pin_delete", "pin_remove")
  UseMethod("pin_delete")
}

Try the pins package in your browser

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

pins documentation built on Nov. 10, 2023, 1:06 a.m.