Liking cljdoc? Tell your friends :D

opencpu-clj.core


call-functionclj

(call-function server-url package-name function-name params)

Calls a function of an installed package on the OpenCPU server. The parameters to the metho a given as a map, which need to match the named parametesr of the R function to call. For details on parameter formats and mappings see the documentation. The functions returns the session key, which can be used to retrieve further information, such as the result of the function call. For details see the OpenCPU API documentation.

Given that the parameters are correct, this call will always succeed, even if the result cannot eventually not be marshalled as Json. (Which means then that the result cannot be transfered in an usefull way from the server to the caller.) But the session key can be used as a parameter to call other functions.

Calls a function of an installed package on the OpenCPU server.
The parameters to the metho a given as a map, which need to match the named parametesr of the
R function to call. For details on parameter formats and mappings see the documentation.
The functions returns the session key, which can be used to retrieve further information,
such as the result of the function call. For details see the OpenCPU API documentation.

Given that the parameters are correct, this call will always succeed, even if the result cannot eventually not be marshalled as Json.
(Which means then that the result cannot be transfered in an usefull way from the server to the caller.)
But the session key can be used as a parameter to call other functions.
sourceraw docstring

call-function-json-RPCclj

(call-function-json-RPC server-url package-name function-name params)
(call-function-json-RPC server-url
                        package-name
                        function-name
                        params
                        query-params)

Calls a function of an installed package on the OpenCPU server. The parameters to the function are given as a map, which need to match the named parametesr of the R function to call. For details on parameter formats and mappings see the documentation. The function returns directly the result which format is further detailed in the API documentation. This only works for functions, which return 'standart' types, such as vectors, lists, dataframes with numbers and strings in it. If the return value cannot be converted to json by OpenCPU, this function will fail.

Calls a function of an installed package on the OpenCPU server.
The parameters to the function are given as a map, which need to match the named parametesr of the
R function to call. For details on parameter formats and mappings see the documentation.
The function returns directly the result which format is further detailed in the API documentation.
This only works for functions, which return 'standart' types, such as vectors, lists, dataframes with numbers and strings in it.
If the return value cannot be converted to json by OpenCPU, this function will fail.
sourceraw docstring

eval-Rclj

(eval-R server-url r-code input-variables out-variables)
(eval-R server-url r-code input-variables out-variables output-format)

Evaluates arbitrary R expressions. Important: They need to be self contained, as they run in an empty R session.

Evaluates arbitrary R expressions.
Important: They need to be self contained, as they run in an empty R session.
sourceraw docstring

get-datasetclj

(get-dataset server-url package-name dataset-path)

Retrieves a dataset from an already installed R package on the OpenCPU server. It gets returned as a core.matrix.dataset

Retrieves a dataset from an already installed R package on the OpenCPU server.
It gets returned as a core.matrix.dataset
sourceraw docstring

json-to-dsclj

(json-to-ds json)
source

session-dataclj

(session-data server-url session-key data-path output-format)

Access to the details of the session data

Access to the details of the session data
sourceraw docstring

cljdoc is a website building & hosting documentation for Clojure/Script libraries

× close