pin_info: Pin Info

Description Usage Arguments Examples

View source: R/pin.R

Description

Retrieve information for a given pin.

Usage

1
2
3
4
5
6
7
8
pin_info(
  name,
  board = NULL,
  extended = TRUE,
  metadata = TRUE,
  signature = FALSE,
  ...
)

Arguments

name

The exact name of the pin to match when searching.

board

The board name used to find the pin.

extended

Should additional board-specific information be shown?

metadata

Should additional pin-specific information be shown?

signature

Should a signature to identify this pin be shown?

...

Additional parameters.

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
library(pins)

# define local board
board_register_local(cache = tempfile())

# cache the mtcars dataset
pin(mtcars)

# print pin information
pin_info("mtcars")

pins documentation built on Jan. 8, 2021, 2:28 a.m.