osfr demo

osfr_demo.R

# devtools::install_github("aaronwolen/osfr")
library(osfr2)
library(stringr)

# retrieve a user
user <- osf_retrieve_user("alh38")
user

# this is an osf_tbl_user
class(user)

# view any osf_tbl directly on osf.io with osf_open()
osf_open(user)

# list user's projects/components
projects <- osf_ls_nodes(user, n_max = 50)
projects

# this is an osf_tbl_node for representing projects/components
class(projects)

# list files within a particular project
files <- osf_ls_files(projects[9, ])
files

# this is an osf_tbl_file for representing files/directories
class(files)

# open an individual file on osf.io
osf_open(files[3,])

# osf_tbls are pipe-friendly (NOTE: still need to add dplyr compatibility)
# e.g. open the keywords.xlsx file from the cancer reproducibility project
projects %>%
  subset(str_detect(name, "Cancer Biology")) %>%
  osf_ls_files() %>%
  subset(str_detect(name, "keywords.xlsx")) %>%
  osf_open()


# upload a file to a new subcomponent of a new project and view it
logo <- system.file("help/figures/logo.png", package = "purrr")

osf_logo <- osf_project_create("Media") %>%
  osf_component_create("Logos", description = "R Package Logos") %>%
  osf_upload(logo)

# we can open a newly uploaded file on osf.io even though GUID's aren't
# assigned until a file has been loaded in the browser
osf_open(osf_logo)