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, ...) {
  check_dots_used()
  check_board(board, "pin_delete", "pin_remove")
  UseMethod("pin_delete")
}
rstudio/pins documentation built on April 12, 2025, 6:59 p.m.