Allows you to Easily Interact with the Algorithmia Platform

The company, Algorithmia, houses the largest marketplace of online algorithms. This package essentially holds a bunch of REST wrappers that make it very easy to call algorithms in the Algorithmia platform and access files and directories in the Algorithmia data API. To learn more about the services they offer and the algorithms in the platform visit < http://algorithmia.com>. More information for developers can be found at < https://algorithmia.com/developers>.


algorithmia-r

R client library for accessing the Algorithmia API

Calling algorithms

First make a client object:

client <- getAlgorithmiaClient("ALGORITHMIA_API_KEY")

Then get the algorithm object:

algorithm <- client$algo("algo://AUTHOR/ALGORITHM_NAME/VERSION")

Call pipe passing in the input to the algorithm:

response <- algorithm$pipe(input)

There are two fields in the result. The meta data (which has timing data) and the result.

result <- response$result

Deployment

New feature release without breaking API changes

  • Verify that the Version field in the DESCRIPTION file has had its minor release version (y in x.y.z incremented from the previously released version, and that the patch version (z in x.y.z) is set to 0.
  • Ensure that CI build passes successfully
  • Run the steps in the test:check_as_cran CI stage inside a Docker container with the image for that stage
  • Verify that the submission follows all CRAN policies.
  • Submit the new package https://xmpalantir.wu.ac.at/cransubmit/
    • Name: Robert Fulton
    • Email: rfulton@algorithmia.com
    • Package: <the tar.gz file that was created from the build>
    • Optional comment:

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("algorithmia")

0.3.0 by Robert Fulton, 6 years ago


Report a bug at https://github.com/algorithmiaio/algorithmia-r/issues


Browse source code at https://github.com/cran/algorithmia


Authors: James Sutton , James Athappilly , Taylor Raack


Documentation:   PDF Manual  


MIT + file LICENSE license


Imports base64enc, httr, rjson

Depends on methods

Suggests knitr, rmarkdown, RUnit


See at CRAN