Skip to content
An R package providing programmatic access to Synapse
R Python Shell Dockerfile
Branch: master
Clone or download
Latest commit ee10247 Jul 10, 2019
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
R fix bug Jul 2, 2019
auto-man
docs
inst/python upgrade Python client version Jun 29, 2019
man Upgrade Python client version Feb 28, 2019
tests simplify test Jul 2, 2019
tools cleanup synapser namespace May 9, 2018
vignettes do not eval unstable tests May 29, 2019
.Rbuildignore Version 0.1.11 is succesfully built on 2018-01-24 Jan 24, 2018
.gitignore add test Aug 13, 2018
DESCRIPTION
Dockerfile
ISSUE_TEMPLATE.md Create ISSUE_TEMPLATE.md Feb 13, 2018
LICENSE Update LICENSE May 4, 2018
NAMESPACE change what will be exposed Feb 20, 2019
NEWS.md Update NEWS.md Feb 28, 2019
README.Rmd Update README.Rmd Mar 26, 2019
README.md fix broken link Jun 21, 2019
cleanup direct module installation into synapser, not PythonEmbedInR Jul 5, 2017
cleanup.win install packages in inst/python-packages Jun 22, 2017
configure update ran URL Mar 12, 2019
configure.win
jenkins.sh fix build May 29, 2019

README.md

synapser

The synapser package provides an interface to Synapse, a collaborative workspace for reproducible data intensive research projects, providing support for:

  • integrated presentation of data, code and text
  • fine grained access control
  • provenance tracking

The synapser package lets you communicate with the Synapse platform to create collaborative data analysis projects and access data using the R programming language. Other Synapse clients exist for Python, Java, and the web browser.

Installation

synapser is available as a ready-built package for Microsoft Windows and Mac OSX. For Linux systems, it is available to install from source. Please also check out our System Dependencies article for instructions on how to install system dependencies on Linux environments.

synapser can be installed or upgraded using the standard install.packages() command, adding the Sage Bionetworks R Archive Network (RAN) to the repository list, e.g.:

install.packages("synapser", repos=c("http://ran.synapse.org", "http://cran.fhcrc.org"))

Alternatively, edit your ~/.Rprofile and configure your default repositories:

options(repos=c("http://ran.synapse.org", "http://cran.fhcrc.org"))

after which you may run install.packages without specifying the repositories:

install.packages("synapser")

If you have been asked to validate a release candidate, please use:

install.packages("synapser", repos=c("http://staging-ran.synapse.org", "http://cran.fhcrc.org"))

Usage

To get started, try logging into Synapse. If you don’t already have a Synapse account, register here:

library(synapser)
synLogin()

Please visit the synapser docs site or view our vignettes for using the synapser package:

browseVignettes(package="synapser")

Usage Examples:

knit2synapse

Knit RMarkdown files to Synapse wikis

syndccutils

Code for managing data coordinating operations (e.g., development of the CSBC/PS-ON Knowledge Portal and individual Center pages) for Sage-supported communities through Synapse.

You can’t perform that action at this time.