R bindings for the AmCAT API
This repository contains the package
which has a number of useful functions for working with the AmCAT API in R.
You can install
amcatr directly from this github repository uising
Note: Every time you run the
the latest version of the package is automatically installed from
Before you can connect to the API, you need to store the password in a file "~/.amcatauth".
This can be done from R by calling
library(amcatr) amcat.save.password("https://amcat.nl", username="example", password="secret")
Note: You only need to run this line once per computer, so do not save this line in a script, and certainly do not publish or email it, to avoid compromising the security of your account!
Now, you can connect to AmCAT using
This requests an authentication token from the specified AmCAT server and stores it for further commands.
The resulting data (named
conn, below) is then used every time you call the API.
library(amcatr) conn = amcat.connect("https://amcat.nl")
All functions in
amcatr start with
amcat. and you can use the built-in help functions to view documentation.
To help you get started with the AmCAT API, please see the following how-to guides: