synDownloader: Instantiate a Synapse downloader

In ArtemSokolov/synExtra: Extension of R Synapse Client

Instantiate a Synapse downloader

Description

Function creates and returns a downloader for files on Synapse.

Usage

synDownloader(dloc, ..., .cache = FALSE)

Arguments

dloc	Path to a local folder where downloaded files will be stored
...	Additional arguments to be passed to synapser::synGet()
.cache	Save files into directories inside dloc corresponding to their md5 hashes. Repeated requests for identical files will re-use already downloaded files

Details

A downloader is itself a function that accepts a vector or list of character strings. Any recognized Synapse IDs get downloaded to the local folder specified by dloc. The downloader then returns local paths to these files. Strings not recognized to be valid Synapse IDs are returned as is.

Download specific versions of files stored on Synapse by suffixing the ID with a version number, e.g. syn123.5

Value

A downloader function that recognizes synapse IDs and downloads the associated files.

Examples

## Not run: 
syn <- synDownloader( "/data", ifcollision="overwrite.local" )
syn( "syn15663039", "localFile.csv" )
# [1] "/data/mtcars.csv" "localFile.csv"

## End(Not run)

ArtemSokolov/synExtra documentation built on Sept. 27, 2022, 12:17 a.m.