pin_find: Find Pin

Description Usage Arguments Details Examples

View source: R/pin.R

Description

Find a pin in any board registered using board_register().

Usage

1
pin_find(text = NULL, board = NULL, name = NULL, extended = FALSE, ...)

Arguments

text

The text to find in the pin description or name.

board

The board name used to find the pin.

name

The exact name of the pin to match when searching.

extended

Should additional board-specific columns be shown?

...

Additional parameters.

Details

pin_find() allows you to discover new resources or retrieve pins you've previously created with pin().

The pins package comes with a CRAN packages board which allows searching all CRAN packages; however, you can add additional boards to search from like Kaggle, Github and RStudio Connect.

For 'local' and 'packages' boards, the 'text' parameter searches the title and description of a pin using a regular expression. Other boards search in different ways, most of them are just partial matches, please refer to their documentation to understand how other boards search for pins.

Once you find a pin, you can retrieve with pin_get("pin-name").

Examples

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
library(pins)

# retrieve pins
pin_find()

# search pins related to 'cars'
pin_find("cars")

# search pins related to 'seattle' in the 'packages' board
pin_find("seattle", board = "packages")

# search pins related to 'london' in the 'packages' board
pin_find("london", board = "packages")


# retrieve 'hpiR/seattle_sales' pin
pin_get("hpiR/seattle_sales")

# retrieve 'bsamGP/London.Mortality' pin
pin_get("bsamGP/London.Mortality")

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