synGet: synGet

Description Usage Arguments Value Examples

Description

Gets a Synapse entity from the repository service.

Usage

1
synGet(entity, version=NULL, downloadFile=NULL, downloadLocation=NULL, followLink=NULL, ifcollision=NULL, limitSearch=NULL)

Arguments

entity

A Synapse ID, a Synapse Entity object,
a named list in which 'id' maps to a Synapse ID or
a local file that is stored in Synapse (found by hash of file)

version

optional named parameter: The specific version to get.
Defaults to the most recent version.

downloadFile

optional named parameter: Whether associated files(s) should be downloaded.
Defaults to TRUE

downloadLocation

optional named parameter: Directory where to download the Synapse File Entity.
Defaults to the local cache.

followLink

optional named parameter: Whether the link returns the target Entity.
Defaults to FALSE

ifcollision

optional named parameter: Determines how to handle file collisions.
May be "overwrite.local", "keep.local", or "keep.both".
Defaults to "keep.both".

limitSearch

optional named parameter: a Synanpse ID used to limit the search in Synapse if entity is
specified as a local file. That is, if the file is stored in multiple
locations in Synapse only the ones in the specified folder/project will be
returned.

Value

A new Synapse Entity object of the appropriate type

Examples

1
2
3
4
5
6
7
8
 
## Not run: 
## download file
file <- synGet('syn1906479')
print(file$properties$name)
print(file$path)

## End(Not run)

Sage-Bionetworks/synapseclient documentation built on Oct. 5, 2018, 4:24 p.m.