Wrapper for rstudio/pins to save DS
elements in folders of users or organisations within AWS S3 buckets.
Check out the full documentation at https://datasketch.github.io/dspins/.
You can install the development version of dspins with:
devtools::install_github("datasketch/dspins")The following two lines will create a pin board called board, using
the folder test within the AWS S3 bucket user.dskt.ch. They return
the same result, as bucket_id defaults to "user".
To create a board, the .env file with the necessary AWS access keys
must be located in the root directory.
board <- ds_board_s3(user_name = "test", bucket_id = "user")
board <- ds_board_s3("test")To pin an element to the board created above, use dspin_write() or
dspin_urls(); dspin_urls() calls dspin_write() and additionally
returns the URLs to file location in the DS profile.
To load a pin, pass the slug of a pin of type fringe and dsviz to
dspin_read(). This will raise an error if the type of the pin is
drop. For pins of type drop, use dspin_download() to download the
pin and to display the file path(s) of the downloaded file(s).
fringe_mtcars <- homodatum::fringe(mtcars, name = "Mtcars dataset")
# Write pins
board %>% dspin_write(fringe_mtcars)
urls <- board %>% dspin_urls(fringe_mtcars)
# Read pins
board %>% dspin_read("mtcars-dataset")
# For a pin of type drop
board %>% dspin_download("slug-of-drop-pin")To check whether a pin exists, delete a pin, or return a list of the
meta data saved in its data.txt file, use the functions
dspin_exists(), dspin_delete(), and dspin_meta() respectively.
board %>% dspin_exists("mtcars-dataset")
board %>% dspin_delete("mtcars-dataset")
board %>% dspin_meta("mtcars-dataset")The dspin_list() function returns a character vector of the slugs of
all pins saved to the board. Using extended = FALSE, it returns a
dataframe with one row per pin and the metadata from the board’s
data.txt file across its columns.
pins <- board %>% dspin_list()
pins_extended <- board %>% dspin_list(extended = TRUE)