These are low-level functions that power pin_read(), pin_write(),
pin_upload(), and pin_download(). They are needed primarily for folks
developing new board types, and should not generally be called directly.
Usage
pin_fetch(board, name, version = NULL, ...)
pin_store(board, name, paths, metadata, versioned = NULL, x = NULL, ...)Arguments
- board
A pin board, created by
board_folder(),board_connect(),board_url()or anotherboard_function.- name
Pin name.
- version
Retrieve a specific version of a pin. Use
pin_versions()to find out which versions are available and when they were created.- ...
Additional arguments passed on to methods for a specific board.
- paths
A character vector of file paths to upload to
board.- metadata
A list containing additional metadata to store with the pin. When retrieving the pin, this will be stored in the
userkey, to avoid potential clashes with the metadata that pins itself uses.- versioned
Should the pin be versioned? The default,
NULL, will use the default forboard- x
An object (typically a data frame) to pin.
Value
pin_fetch() is called primarily for its side-effect of downloading
remote pins into the local cache. It returns the same data as pin_meta.
pin_store() is called for its side-effect of uploading a local file
to a remote board. It invisibly returns the fully qualified pin name.
Examples
board <- board_temp()
board %>% pin_upload(system.file("CITATION"))
#> Guessing `name = 'CITATION'`
#> Creating new version '20241007T174654Z-f5b9d'
path <- board %>% pin_download("CITATION")
path
#> [1] "/tmp/RtmphSQBxo/pins-170c27b5ef09/CITATION/20241007T174654Z-f5b9d/CITATION"
readLines(path)[1:5]
#> [1] "bibentry(\"Manual\","
#> [2] " title = \"R: A Language and Environment for Statistical Computing\","
#> [3] " author = person(\"R Core Team\"),"
#> [4] " organization = \"R Foundation for Statistical Computing\","
#> [5] " address = \"Vienna, Austria\","