osfr (version 0.1.1)

clone_project: Clone OSF project to desktop

Description

This function copies an entire project and its components to the harddrive of the individual (depth of clone depends on the maxdepth argument). There is currently no way to estimate the size before downloading so it might take a while. BUT there's a progess bar :-) Currently limited to only files stored on OSF (not via add-ons).

Usage

clone_project(id, private = FALSE, maxdepth = 5)

Arguments

id

OSF id (osf.io/XXXXX; just XXXXX)

private

clone the project as seen privately?

maxdepth

how many levels of subcomponents to trawl

Value

Boolean, clone success

Examples

# NOT RUN {
clone_project(id = "12345")
# }