Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migrated to Confluence 5.3

...

  1. Follow the instructions to install the current production version of the R client, this will automatically install most dependencies 
    Include Page
    SYNR:How to install the Synapse R Client
    SYNR:How to install the Synapse R Client
  2. Install any additional required dependences, from the R prompt
    • install.packages(c("RUnit","rJava"))
  3. Install the developer tools needed for R Developer Tools#R
  4. Make sure your maven settings file is pointing to the 64bit version of R
    • Mac OSX

      Code Block
      <properties>
              <local.r.path>/usr/bin/r</local.r.path>
      ...
            </properties>
      
    • Windows

      Code Block
      <properties>
              <local.r.path>C:\Program Files\R\R-2.13.0\bin\x64\R.exe</local.r.path>
      ...
            </properties>
      
  5. You now need to checkout and build the entire Synapse code tree since the R client now depends upon the Java client, Get the Maven Build working
  6. Build the Sage Bionetworks R package, from the shell
    • Rcmd INSTALL rSynapseClient
  7. If you see a loading error for rJava, include $JAVA_HOME$/jre/bin/server in your PATH.
  8. Now you are ready to use it, from the R prompt
    • library (synapseClient)

Note that every time you change the Java Synapse Client and want to pick up those changes in the R client, you'll need to do an mvn install in each.

How to run the R client against staging

Code Block
synSetEndpoints('https://repo-staging.prod.sagebase.org/repo/v1',
                'https://auth-staging.prod.sagebase.org/auth/v1',
                'https://file-staging.prod.sagebase.org/file/v1', 
                'https://staging.synapse.org/')

 

How to run the R unit tests

...