Retrieves a pin by name from the local or given board.

pin_get(name, board = NULL, cache = TRUE, extract = NULL, ...)

Arguments

name

The name of the pin.

board

The board where this pin will be retrieved from.

cache

Should the pin cache be used? Defaults to TRUE.

extract

Should compressed files be extracted? Each board defines the deefault behavior.

...

Additional parameters.

Details

pin_get() retrieves a pin by name and, by default, from the local board. You can use the board parameter to specify which board to retrieve a pin from. If a board is not specified, it will use pin_find() to find the pin across all boards and retrieve the one that matches by name.

Examples

library(pins) # define local board board_register_local(cache = tempfile()) # cache the mtcars dataset pin(mtcars) # retrieve the mtcars pin pin_get("mtcars")
#> # A tibble: 32 x 11 #> mpg cyl disp hp drat wt qsec vs am gear carb #> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> <dbl> #> 1 21 6 160 110 3.9 2.62 16.5 0 1 4 4 #> 2 21 6 160 110 3.9 2.88 17.0 0 1 4 4 #> 3 22.8 4 108 93 3.85 2.32 18.6 1 1 4 1 #> 4 21.4 6 258 110 3.08 3.22 19.4 1 0 3 1 #> 5 18.7 8 360 175 3.15 3.44 17.0 0 0 3 2 #> 6 18.1 6 225 105 2.76 3.46 20.2 1 0 3 1 #> 7 14.3 8 360 245 3.21 3.57 15.8 0 0 3 4 #> 8 24.4 4 147. 62 3.69 3.19 20 1 0 4 2 #> 9 22.8 4 141. 95 3.92 3.15 22.9 1 0 4 2 #> 10 19.2 6 168. 123 3.92 3.44 18.3 1 0 4 4 #> # … with 22 more rows
# retrieve mtcars pin from packages board pin_get("easyalluvial/mtcars2", board = "packages")
#> # A tibble: 32 x 12 #> mpg cyl disp hp drat wt qsec vs am gear carb ids #> <dbl> <ord> <dbl> <dbl> <dbl> <dbl> <dbl> <fct> <fct> <ord> <ord> <chr> #> 1 21 6 160 110 3.9 2.62 16.5 V manual 4 4 Mazda RX4 #> 2 21 6 160 110 3.9 2.88 17.0 V manual 4 4 Mazda RX… #> 3 22.8 4 108 93 3.85 2.32 18.6 S manual 4 1 Datsun 7… #> 4 21.4 6 258 110 3.08 3.22 19.4 S automa… 3 1 Hornet 4… #> 5 18.7 8 360 175 3.15 3.44 17.0 V automa… 3 2 Hornet S… #> 6 18.1 6 225 105 2.76 3.46 20.2 S automa… 3 1 Valiant #> 7 14.3 8 360 245 3.21 3.57 15.8 V automa… 3 4 Duster 3… #> 8 24.4 4 147. 62 3.69 3.19 20 S automa… 4 2 Merc 240D #> 9 22.8 4 141. 95 3.92 3.15 22.9 S automa… 4 2 Merc 230 #> 10 19.2 6 168. 123 3.92 3.44 18.3 S automa… 4 4 Merc 280 #> # … with 22 more rows