synGetFiles: This function pulls files from a synapse project

View source: R/synGetFiles.R

synGetFilesR Documentation

This function pulls files from a synapse project

Description

This function downloads all of the network files in a synapse parent folder using the synID of the folder containing folders of specific network types. It uses the name of the folder plus a pattern id eg. 'Network' to find network files. for example the 'ridgeAIC/' folder in 'project_id' will need to contain the ‘ridgeAICNetwork' file if pattern_id = ’Network' and 'project_id' is set to the parent folder containing 'ridgeAIC/'. The files will be downloaded to the path specified in 'downloadLocation'.

Usage

synGetFiles(project_id, pattern_id, downloadLocation = getwd())

Arguments

project_id

Required. A character vector of a synapse ID of a synapse project.

pattern_id

Required. A character vector too match in the file names of the children entities in 'project_id'.

downloadLocation

Optional. Local directory to download the files to. Default = 'getwd()'

Value

A character vector of file paths


Sage-Bionetworks/metanetwork documentation built on April 27, 2022, 7:42 a.m.