opencpu-clj.ocpu — opencpu-clj 0.3.1

library clj

(library base-url)

(library base-url package-name)

(library base-url package-location-info package-name)

Does a call to the OpenCPU 'library' endpoint. base-url : url and port of the OpenCPU server package-name : name of system wide installed R package to use package-location-info : suports {:type :user :user-name 'jeroen'} for accessing R package of a user

Returns a map with keys :result and :status , containing the result of the call or an error message. The value of :status is the http status code.

object clj

(object base-url library-name package-name object-type object-name)

(object base-url library-name package-name object-type object-name params)

(object base-url
        library-name
        package-name
        object-type
        object-name
        params
        output-format)

(object base-url
        library-name
        package-name
        object-type
        object-name
        params
        output-format
        query-params)

Does a call to the OpenCPU 'object' endpoint. base-url : url and port of the OpencPU server library-name : :library or :cran package-name : name of system wide installed R package to use object-type : :R or :data to acces R-functions or data object-name : name of the function or data object params : map of params to the R function to be called. Need to be a map where each key will be used to set a named argument in the R function call. The values need to be encoded in Json in a format which the R function jsonlite::fromJSON is able to convert to the correct R type. If not nil this will do a http POST, else a http GET. For the special case of file uploads, the parameter value can be a map like this: {:file filename} output-format : can be a keyword for choosing any of the valid output-formats (see OpenCPU docu) query-params: additional query params, used for arguments of output-format conversion functions

If library-name is :gist, then the following paramters get's interpreted as 'gist-username', 'gist', 'filename' and the gist file gets executed (no parameter passing possible)

Returns a map with keys :result and :status , containing the result in output-format of the call or an error message. The value of :status is the http status code. The :result can either be

• a list of session links (for a function call, if :json was not specified)
• a clojure data structure (for a function call and :json was specified and return was a simple value which http-client cou auto-coerce from json)
• a string in the output format asked for (:json, :csv, ..)

package clj

(package base-url package-name path & man-params)

Does a call to the OpenCPU 'package' endpoint. base-url : url and port of the OpenCPU server package-name : name of system wide installed R package to use path : 'man' for man pages , 'info' for package info man-params : further parameters

Returns a map with keys :result and :status , containing the result of the call or an error message. The value of :status is the http status code.

session clj

(session base-url session-path output-format)

Does a call to the OpenCPU 'session' endpoint. base-url : url and port of the OpenCPU server session-path : The path to the session object, as returned from the 'object' function.

Returns a map with keys :result and :status , containing the result of the call or an error message. The value of :status is the http status code.