Developer Tools, API Docs, and Samples

Applies to: DeployR 8.x (See comparison between 8.x and 9.x)

Looking to deploy with Machine Learning Server? Start here.

Get started with DeployR! Use the RBroker framework and/or the client libraries to communicate with the DeployR server.

On this page, you can download the framework/library in one of the available languages, follow their tutorials, and consult the comprehensive documentation.

RBroker Framework

The RBroker Framework is the simplest way to integrate R Analytics into any Java, JavaScript or .NET application. Submit as many R tasks as your application needs. No need to manage client-side request queues or block for results. Let this framework handle all of the complexity while you enjoy effortless scale. Simply define an RTask, submit your task to an instance of RBroker and then retrieve your RTaskResult. It really is that simple.

1. Read the RBroker Framework Tutorial

2. Get the documentation and download the library for your preferred programming language:

   • Java:              API Doc  |  Download
   • JavaScript:    API Doc  |  Download
   • .NET:              API Doc  |  Download
      

3. Explore the RBroker Framework examples for Java, JavaScript, and .NET. Find them under the examples directory of each GitHub repository. Check out additional sample applications that use the client library or RBroker for Java and JavaScript.

Client Libraries

The DeployR API exposes a wide range of R analytics services to client application developers. If the RBroker Framework doesn't give you exactly what you need then you can get access to the full DeployR API using our client libraries. We currently provide native client library support for Java, JavaScript or .NET developers.

1. Read the Client Library Tutorial

2. Get the documentation and download the library for your preferred programming language:

   • Java:              API Doc  |  Download
   • JavaScript:    API Doc  |  Download
   • .NET:              API Doc  |  Download
      

3. Explore the client library examples for Java, JavaScript, and .NET. Find them under the examples directory of each GitHub repository. Check out additional sample applications that use the client library or RBroker for Java and JavaScript.

API Reference and Tools

Need to integrate DeployR-powered R Analytics using a different programming language? The API Reference guide details everything you need to know to get up and running.

Also described is the API Explorer tool used to interactively learn the DeployR API.