microsoft/dotnet-client-library

.NET Client Library for DeployR

.NET Client Library for DeployR

The DeployR API exposes a wide range of R analytics services to client application developers. These services are exposed using standards based JSON/XML and are delivered by the DeployR server as Web services over HTTP(S).

The DeployR .NET client library is provided to simplify the integration of DeployR services within .NET client applications.

Links

• Download
• Quick Start Tutorial
• Client Library API .NET Help File
• DeployR API Reference Guide
• Library Dependencies
• Example Code
• License

Dependencies

Bundled DLL Dependencies

Besides the DeployR .NET library itself, DeployR<version>.dll, there are a number of 3rd party DLL file dependencies. These additional DLL file dependencies are provided for your convenience in the lib directory within this repository.

Building the .NET Client Library

The DeployR .NET Client Library is managed with Visual Studio 2013, using .NET Framework 4.5.1. The build.bat file at the root of this repository can be used to build the library

A successful build will result in the creation of DeployR-DotNet-Client-<version>.zip file containing the DeployR client library and it's dependencies. It will also create a DeployR.chm help file.

Please review the variables in the build.bat file and adjust as necessary for your environemnt

Examples

The DeployR .NET client library ships with a number of sample applications provided to demonstrate some of the key featues introduced by the Quick Start Tutorial for the .NET client library. See here for details.

Help

The DeoployR .NET help file is built with Sandcastle Help File Builder. The file "deployR.shfbproj", is a "Sandcastle Help File Builder" project file

Sandcastle Help File Builder

License

Copyright (C) 2010-2015 by Microsoft Corporation

This program is licensed to you under the terms of Version 2.0 of the Apache License. This program is distributed WITHOUT ANY EXPRESS OR IMPLIED WARRANTY, INCLUDING THOSE OF NON-INFRINGEMENT, MERCHANTABILITY OR FITNESS FOR A PARTICULAR PURPOSE. Please refer to the Apache License 2.0 (http://www.apache.org/licenses/LICENSE-2.0) for more details.

dotnet-client-library's Issues

Execution History Call

Hi guys,

I've got some execution results saved on a project on our deployr enterprise server, however, I'm finding that the project.getHistory() call always results in an empty execution history list. The response to the http request (/r/project/execute/history) contains the data, but I believe its not being parsed correctly by the c# client library.

On line 308 of the RProjectExecutionImpl.cs file, it seems to be looking directly for the "history" node and ignoring its parent "execution" node.

Can you verify this please?

Serialization error due to invalid cast

Within the JSONSerialize class when RData.Type is of type "matrix", RData.Value, which is a List<List<double?>> was being cast to a List. This cast throws an exception. As I have never contributed to an open source project on GitHub, I have only made these changes locally and would appreciate a 2nd opinion to confirm this issue.

Missing Repository Directory on loadFile

wrong HTTP option specified for preloading a directory.

The HTTP option should be "preloadFileDirectory" not "preloadDirectory"

Can you pack and upload these libraries to nuget.org?

Vector with one element returns "RNumeric", while vector with many elements returns "RNumericVector"

When getting the result of the generated objects, a vector with one element returns "RNumeric", while vector with many elements returns "RNumericVector". I believe both should return "RNumericVector".

In the R script I am type casting to vector:

newscale <- as.vector(results$par)

When I get the generated objects, I am having to check the type before I place the objects into a List.

RTaskToken rTaskToken = rBroker.submit(rTask);
RTaskResult rTaskResult = rTaskToken.getResult();
foreach (var rslt in rTaskResult.getGeneratedObjects())
{
    if (rslt.Name.ToLower().Equals("newscale"))
    {
        var rsltList = new List<double?>();
        if (rslt.RClass == "numeric" && rslt.Type == "primitive")
        {
            rsltList.Add((double?)rslt.Value);
        }
        else
        {
            rsltList = ((IEnumerable<double?>)rslt.Value).ToList();
        }
    }
}

This repo is missing important files

There are important files that Microsoft projects should all have that are not present in this repository. A pull request has been opened to add the missing file(s). When the pr is merged this issue will be closed automatically.

Microsoft teams can learn more about this effort and share feedback within the open source guidance available internally.

Merge this pull request

Rename Repository?

I just noticed this repo on the first page of the Microsoft GitHub org, and this was the first thing that came to mind: “dotnet-client-library for what, exactly? Oh — it’s DeployR.” Do you think it would be possible to rename this repo to something like dotnet-deployr-client-library? Thanks!

SSL certificate errors are not managed on Web Requests