...

Build the Client and run the test suite

Build the client

Once you've made changes it's time to build the client and run the test suite.  There are two ways to build.  Both paths download the Synapse object JSON schemas and auto-generate certain documentation files.  The first does a basic installation in just a few seconds:

1. tools/prebuild.sh
2. R CMD install .

The second option does a complete build, including 'vignettes'.  It requires LaTeX to be installed on your machine and takes a minute or more to run:

1. tools/build.sh

Run the test suite

Now start up R and run the test suite:

library(synapseClient)
synapseClient:::.test()

synapseLogin()
synapseClient:::.integrationTest()

".test()" runs unit tests, i.e. tests which do not contact the Synapse server.  ".integrationTest()" runs those tests that do contact the server, creating and deleting content as they go.

Push your code changes to Github

...