board_register: Board registry (legacy API)

In pins: Pin, Discover, and Share Resources

Board registry (legacy API)

Description

The legacy pins API uses a board registry, where you first register a board then refer to it by name in calls to pin functions.

Usage

board_register(board, name = NULL, cache = NULL, versions = NULL, ...)

board_register_rsconnect(
  name = "rsconnect",
  server = NULL,
  account = NULL,
  key = NULL,
  output_files = FALSE,
  cache = NULL,
  ...
)

board_deregister(name, ...)

board_default()

board_list()

board_get(name)

Examples

# legacy API
board_register_local("myboard", cache = tempfile())
pin(mtcars, board = "myboard")
pin_get("mtcars", board = "myboard")

# modern API (not available for all boards)
board <- board_temp()
board %>% pin_write(mtcars)
board %>% pin_read("mtcars")

pins documentation built on Oct. 7, 2024, 5:07 p.m.