get_course_results {rqti}R Documentation

Get zip with course results by resource id and node id

Description

Get zip with course results by resource id and node id

Usage

get_course_results(
  resource_id,
  node_id,
  path = ".",
  rename = TRUE,
  api_user = NULL,
  api_password = NULL,
  endpoint = NULL
)

Arguments

resource_id

A length one character vector with resource id.

node_id

A length one character vector with node id (test).

path

A length one character vector with path, where the zip should be stored. Default is working directory.

rename

A boolean value; optional; Set TRUE value to take the short name of the course element for naming zip (results_shortName.zip). FALSE combines in zip name course id and node id. Default is TRUE.

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

It downloads a zip and return a character string with path.

Examples


zip_file <- get_course_results("89068111333293", "1617337826161777006")


[Package rqti version 0.3.0 Index]