Learn R Programming
synapseClient (version 1.14-0)

File: Synapse File Constructor

Description

Constructor for File

Usage

File(path, parentId, synapseStore=TRUE, ...)

Arguments

path
Path to the file in local file system, or URL to file on the internet
parentId
The Synapse ID of the parent Project or Folder in which to store the File (e.g. "syn101")
synapseStore
If 'synapseStore' is TRUE then the file specified by path will be uploaded to S3 when the constructed File object is passed to synStore(), else only the file location is saved, along with other metadata
...
Additional named parameters are interpreted as properties or annotations on the File

Value

The created File is returned. NOTE: This is an in-memory representation. To persist to Synapse use synStore().

Slots

Details

If the parent Project has an associated data store, credentials to access the store should be placed in your '.synapseConfig' file: The .synapseConfig file goes in your home directory and is in the ".ini" format. Create a new section in the file for the server to be accessed. The section title is the protocol and host. Below, put lines for username and password, e.g.: [sftp://remote.host.com]

username=myUserName

password=secret

See Also

Folder Project synGet synStore