Skip to contents

Setting environment variables to use library(examiner) with Canvas

Source: R/canvas.R
canvas_env_vars.Rd

If you need a detailed walkthrough, see Get started > Configuration.

Details

The following environment variables are required. For an RStudio project, they can be conveniently set in an .Renviron file in the project directory.


CANVAS_DOMAIN=https://example.instructure.com
CANVAS_COURSE_ID=1234
CANVAS_API_TOKEN=54321~1LqZ...

Meaning:

  • CANVAS_DOMAIN: The domain of your Canvas LMS instance, e.g. https://example.instructure.com.

  • CANVAS_COURSE_ID: The ID of the course you are accessing, e.g. 1234 for https://example.instructure.com/courses/1234.

  • CANVAS_API_TOKEN: A valid API token for authenticating requests. Get one from https://example.instructure.com/profile/settings, "New Access Token".