Skip to contents

Upload a resource on OPAL

Source: R/Opal.R
upload2opal.Rd

Function upload2opal() takes full prepared zip archive of QTI-test or QTI-task and uploads it to the OPAL.

Usage

upload2opal(
  test,
  display_name = NULL,
  access = 4,
  overwrite = TRUE,
  endpoint = NULL,
  open_in_browser = TRUE,
  as_survey = FALSE,
  api_user = NULL
)

Arguments

test

A length one character vector of AssessmentTest, AssessmentTestOpal or AssessmentItem objects, Rmd/md or XML files; required.

display_name

A length-one character vector naming the file in OPAL; by default, this is the file name without extension; optional.

access

An integer value, optional; it controls publication status, where 1 - only those responsible for this learning resource; 2 - responsible and other authors; 3 - all registered users; 4 - registered users and guests. Default is 4.

overwrite

A boolean value; if TRUE and exactly one file with the specified display name is found, it will be overwritten. Default is TRUE.

endpoint

A string containing the OPAL LMS endpoint; by default, it is read from environment variable RQTI_API_ENDPOINT. To set a global environment variable, you need to call Sys.setenv(RQTI_API_ENDPOINT='xxxxxxxxxxxxxxx') or put this command into .Renviron.

open_in_browser

A boolean value, optional; controls whether to open a URL in the default browser. Default is TRUE.

as_survey

A boolean value, optional; controls the resource type (test or survey). Default is FALSE.

api_user

A character value of the username in the OPAL.

Value

A list with the key, display name, and URL of the resource in Opal.

Examples

if (FALSE) { # interactive()
file <- system.file("exercises/sc1.Rmd", package='rqti')
upload2opal(file, "task 1", open_in_browser = FALSE)
}