get_course_elements {rqti}R Documentation

Get elements of the course by courseId

Description

Get elements of the course by courseId

Usage

get_course_elements(
  course_id,
  api_user = NULL,
  api_password = NULL,
  endpoint = NULL
)

Arguments

course_id

A length one character vector with course id.

api_user

A character value of the username in the OPAL.

api_password

A character value of the password in the OPAL.

endpoint

A string of endpoint of LMS Opal; by default it is got from environment variable RQTI_API_ENDPOINT. To set a global environment variable, you need to call Sys.setenv(RQTI_API_ENDPOINT='xxxxxxxxxxxxxxx') or you can put these command into .Renviron.

Value

A dataframe with the elements of the course (fields: nodeId, shortTitle, shortName, longTitle)

Examples


df <- get_course_elements("89068111333293")


[Package rqti version 0.3.0 Index]