osf_download_file: Download OSF File

Description Usage Arguments Value Examples

View source: R/osf-download-file.R

Description

Download OSF File

Usage

1
osf_download_file(osf_id, path = NULL, ...)

Arguments

osf_id

character, the OSF file's unique identifier (e.g., "tskpu")

path

Local path where the downloaded file will be saved. The default is to use the remote file's name.

...

a list of parameters that are passed on to osf_download()

Value

The osf_tbl_file input with a new column, "local_path", containing the downloaded file's path.

Examples

1
2
3
4
## Not run: 
  osf_download_file("tskpu","iris.csv")

## End(Not run)

tiernanmartin/drakepkg documentation built on March 11, 2020, 3:11 a.m.