Skip to content

Latest commit

 

History

History

r-client

Folders and files

NameName
Last commit message
Last commit date

parent directory

..
src
src
 
 
README.md
README.md
 
 
Vagrantfile
Vagrantfile
 
 
provision.sh
provision.sh
 
 

README.md

Gro API Client R Usage Example

This is a proof of concept use of the Gro API Python client (https://github.com/gro-intelligence/api-client), imported and used in R via the reticulate R library (https://github.com/rstudio/reticulate). No special formatting or configuration needs to be done to the API client itself as plain Python functions interop with R inputs and outputs.

Using the API Client in R

Pre-requisites

  • Python
  • pip
  • virtualenv
  • R

Importing the client

# Reticulate allows python code to be used within R. Install and import
install.packages("reticulate",repos = "http://cran.us.r-project.org")
library(reticulate)
# Install and import the Gro API client
py_install("git+https://github.com/gro-intelligence/api-client.git")
gro_client <- import("api.client.gro_client")
# Create and authenticate a client object
groclient = gro_client$GroClient("api.gro-intelligence.com","put-your-api-token-here")
# -- Use the client below this line --

Replace the token string with your own token. See the project README for details on how to retrieve a token.

Running the example Vagrantfile

This Vagrantfile creates an Ubunutu 16.04 virtual machine, installs Python and R dependencies, and runs an R script emulating the quickstart example from quick_start.py outputing an R dataframe at the end.

This is implemented as a Vagrantfile to demonstrate a known working configuration. This example is in no way saying you must or should use Vagrant if intending to use the Gro API in R yourself.

It is important to note that because R is not an officially supported language for using the Gro API, integrating into your own environment may take extra configuration on the user's part, and not all features are tested.

Pre-requisites for Vagrant

  • vagrant
  • virtualbox

Preparation

In src/testscript.R replace the token string with your own token. See the project README for details on how to retrieve a token.

Run

$ vagrant up

To use this VM for testing your own R scripts

Modify src/testscript.R or create a copy of it, and replace the add_single_data_series and get_df lines with your own logic. Then,

$ vagrant ssh
  password: vagrant
$ Rscript /vagrant/<your-script>

to run your own version of the script. Note it will create a new virtual environment and reinstall the Gro API client each time, so it does take a little while to run.

Destroy

$ vagrant destroy default -f

Documentation