Skip to content

Latest commit

 

History

History
23 lines (12 loc) · 1.37 KB

README.md

File metadata and controls

23 lines (12 loc) · 1.37 KB

Canvas LMS API for R

This package attempts to provide programmatic access to Canvas LMS from R. It is far from complete, the main purpose at this point is to centralise the efforts, such that we add the functions as we need to do something rather than just keeping various scripts around.

Before you can use this package, you have to obtain a Canvas API token and set the two environment variables CANVAS_API_TOKEN and CANVAS_API_DOMAIN where the latter is the URL of your Canvas server, typically something like https://canvas.my-uni.edu/api/v1.

For high-level functions try something like courses() and look up help such as ?files or ?pages.

The low-level work-horse is canvas:::.hc() which simply takes the path portion of the URL and adds all other necessary pieces. The API is still in flux, so it may change (for the better), but generally something like canvas:::.hc(,"courses") works. There is also canvas:::.chk() which checks the result and attempts to parse it, so most high-level function simply call .chk(.hc(...)).

Installation

From the repository:

install.packages("canvas", repo="https://rforge.net")

From the source: you have to call sh mkdist first to generate a valid package tar ball and you need knitr and roxygen2 packages to generate artifacs.

RForge