Package 'rqti'

Description

This method adds a user to a group on the Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

This method adds a user to a learning group in LMS Opal by group id and user id.

Usage

addGroupUser(object, group_id, user_id)

## S4 method for signature 'missing'
addGroupUser(object, group_id, user_id)

## S4 method for signature 'Opal'
addGroupUser(object, group_id, user_id)

Arguments

Value

Status code of the HTTP request.

Status code 200 if the user was added successfully, or NULL when OPAL rejects the request.

Examples

addGroupUser("442662912", "196610")


addGroupUser("442662912", "196610")

Description

Abstract class AssessmentItem is responsible for creating a root element 'assessmentItem' in XML task description according to QTI 2.1. This class is not meant to be instantiated directly; instead, it serves as a base for derived classes.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

Create an object AssessmentSection

Description

Create an AssessmentSection rqti-object as part of a test content

Usage

assessmentSection(
  assessment_item,
  identifier = generate_id(type = "section"),
  title = identifier,
  selection = NA_integer_,
  time_limit = NA_integer_,
  visible = TRUE,
  shuffle = FALSE,
  max_attempts = NA_integer_,
  allow_comment = TRUE
)

Arguments

Value

An object of class AssessmentSection.

See Also

section(), test(), test4opal()

Examples

sc <- singleChoice(prompt = "Question", choices = c("A", "B", "C"))
es <- essay(prompt = "Question")
# Since ready-made S4 "AssessmentItem" objects are taken, in this example a
#permanent section consisting of two tasks is created.
s <- assessmentSection(list(sc, es), title = "Section with nonrandomized tasks")

Description

Class AssessmentSection is responsible for forming a section in the test XML specification according to QTI 2.1.

Slots

identifier

A character representing the unique identifier of the assessment section. By default, it is generated as 'id_section_dddd', where dddd represents random digits.

title

A character representing the title of the section in the test. By default, it takes the value of the identifier.

time_limit

A numeric value, optional, controlling the amount of time in minutes a candidate is allowed for this part of the test.

visible

A boolean value, optional. If TRUE, it shows this section in the hierarchy of the test structure. Default is TRUE.

assessment_item

A list containing AssessmentSection and/or Assessment item objects, such as SingleChoice, MultipleChoice, Essay, Entry, Ordering, OneInRowTable, OneInColTable, MultipleChoiceTable, and DirectedPair.

shuffle

A boolean value, optional, determining whether to randomize the order in which the assessment items and subsections are initially presented to the candidate. Default is FALSE.

selection

A numeric value, optional, defining how many children of the section are delivered in the test.

max_attempts

A numeric value, optional, enabling the maximum number of attempts a candidate is allowed to make in this section.

allow_comment

A boolean value, optional, allowing the candidate to leave comments on each question of the section. Default is TRUE.

See Also

section(), test(), test4opal(), AssessmentTest, AssessmentTestOpal.

Examples

sc1 <- new("SingleChoice", prompt = "Example task 1", title = "SC1",
             identifier = "q1", choices = c("a", "b", "c"))
sc2 <- new("SingleChoice", prompt = "Example task 2", title = "SC2",
             identifier = "q2", choices = c("A", "B", "C"))
sc3 <- new("SingleChoice", prompt = "Example task 3", title = "SC3",
             identifier = "q3", choices = c("aa", "bb", "cc"))
exam_section <- new("AssessmentSection",
                    identifier = "sec_id",
                    title = "Section",
                    time_limit = 20,
                    visible = FALSE,
                    assessment_item = list(sc1, sc2, sc3),
                    shuffle = FALSE,
                    selection = 1,
                    max_attempts = 1,
                    allow_comment = FALSE)

Create an object AssessmentTest

Description

Create an AssessmentTest rqti-object.

Usage

assessmentTest(
  section,
  identifier = generate_id(type = "test"),
  title = identifier,
  time_limit = NULL,
  max_attempts = 1L,
  fallback_titles = "generic",
  academic_grading = NULL,
  grade_label = c(en = "Grade", de = "Note"),
  table_label = c(en = "Grade", de = "Note"),
  navigation_mode = "nonlinear",
  submission_mode = "individual",
  allow_comment = TRUE,
  rebuild_variables = TRUE,
  metadata = qtiMetadata(),
  stylesheet_path = NULL,
  points = NA_real_
)

Arguments

Value

An AssessmentTest object.

See Also

test(), test4opal(), section(), AssessmentTest, AssessmentSection

Examples

sc <- sc <- singleChoice(prompt = "Question", choices = c("A", "B", "C"))
es <- new("Essay", prompt = "Question")
s <- section(c(sc, es), title = "Section with nonrandomized tasks")
t <- assessmentTest(list(s), title = "Example of the Exam")

Description

Class AssessmentTest is responsible for creating XML exam files according to the QTI 2.1 standard.

Details

Test consists of one or more sections. Each section can have one or more questions/tasks and/or one or more sub sections.

Slots

identifier

A character representing the unique identifier of the assessment test. By default, it is generated as 'id_test_dddd', where dddd represents random digits.

title

A character representing the title of the test. By default, it takes the value of the identifier.

points

Do not use directly; the maximum number of points for the exam/test. It is calculated automatically as a sum of points of included tasks.

test_part_identifier

A character representing the identifier of the test part.

navigation_mode

A character value, optional, determining the general paths that the candidate may have during the exam. Possible values:

• "linear" - candidate is not allowed to return to the previous questions.

• "nonlinear" - candidate is free to navigate. This is used by default.

submission_mode

A character value, optional, determining when the candidate's responses are submitted for response processing. Possible values:

• "individual" - submit candidates' responses on an item-by-item basis. This is used by default.

• "simultaneous" - candidates' responses are submitted all together by the end of the test.

section

A list containing one or more AssessmentSection objects.

time_limit

A numeric value, optional, controlling the amount of time in minutes which a candidate is allowed for this part of the test.

max_attempts

A numeric value, optional, enabling the maximum number of attempts that a candidate is allowed to make.

allow_comment

A boolean value, optional, allowing candidates to leave comments on each question.

rebuild_variables

A boolean value, optional, allowing variables to be recalculated and the order of choices to be reshuffled for each item attempt.

fallback_titles

A character value, optional, controlling how titles are assigned when no explicit title is provided. Possible values are "filename" (use filenames as titles) and "generic" (use generic labels such as "Section 1", "Section 1.2", or "Task 1.2.1"). Default is "generic".

academic_grading

A named numeric vector that defines the grade table shown to the candidate as feedback at the end of the test.

Each grade corresponds to the minimum percentage score required to achieve it. A helper function german_grading() is available to generate a common German grading scheme.

The default is NULL, which means that no grading table is shown. To display a grading table, provide a named numeric vector or use german_grading().

grade_label

A character value, optional, representing a short message to display with a grade in the final feedback. For multilingual usage, it has to be a named vector with two-letter ISO language codes as names (e.g., c(en="Grade", de="Note")); during test creation, it takes the value for the language of the operating system. Default is c(en="Grade", de="Note").

table_label

A character value, optional, representing a concise message to display as the column title of the grading table in the final feedback. For multilingual usage, it has to be a named vector with two-letter ISO language codes as names (e.g., c(en="Grade", de="Note")); during test creation, it takes the value for the language of the operating system. Default is c(en="Grade", de="Note").

stylesheet_path

A character value, optional, specifying the path to a custom CSS stylesheet. If provided, the stylesheet is included at the assessment test level and applied during rendering. When academic_grading is set, the default stylesheet styles/rqti.css is included automatically; a user-defined stylesheet is added in addition and may override default styles.

metadata

An object of class QtiMetadata that holds metadata information about the test.

See Also

AssessmentSection, AssessmentTestOpal, test(), test4opal(), section().

Examples

# This example creates test 'exam' with one section 'exam_section' which
# consists of two questions/tasks: essay and single choice types
task1 <- new("Essay", prompt = "Test task", title = "Essay",
             identifier = "q1")
task2 <- new("SingleChoice", prompt = "Test task", title = "SingleChoice",
             choices = c("A", "B", "C"), identifier = "q2")
exam_section <- new("AssessmentSection", identifier = "sec_id",
                    title = "section", assessment_item = list(task1, task2))
exam <- new("AssessmentTest",
            identifier = "id_test_1234",
            title = "Example of Exam",
            navigation_mode = "linear",
            submission_mode = "individual",
            section = list(exam_section),
            time_limit = 90,
            max_attempts = 1,
            grade_label = "Preliminary grade")

Create an object AssessmentTestOpal

Description

Create an AssessmentTestOpal rqti-object.

Usage

assessmentTestOpal(
  section,
  identifier = generate_id(type = "test"),
  title = identifier,
  time_limit = NULL,
  max_attempts = 1L,
  fallback_titles = "generic",
  academic_grading = NULL,
  grade_label = c(en = "Grade", de = "Note"),
  table_label = c(en = "Grade", de = "Note"),
  navigation_mode = "nonlinear",
  submission_mode = "individual",
  allow_comment = TRUE,
  rebuild_variables = TRUE,
  show_test_time = TRUE,
  calculator = NA_character_,
  mark_items = TRUE,
  keep_responses = FALSE,
  files = character(),
  stylesheet_path = NULL,
  metadata = qtiMetadata(),
  points = NA_real_
)

Arguments

Value

An AssessmentTestOpal object.

See Also

test(), test4opal(), section(), assessmentTest(), AssessmentTest, AssessmentSection

Examples

sc <- sc <- singleChoice(prompt = "Question", choices = c("A", "B", "C"))
es <- new("Essay", prompt = "Question")
s <- section(c(sc, es), title = "Section with nonrandomized tasks")
t <- assessmentTest(list(s), title = "Example of the Exam")

Description

Class AssessmentTestOpal is responsible for creating XML exam files according to the QTI 2.1 standard for LMS Opal.

Details

Test consists of one or more sections. Each section can have one or more questions/tasks and/or one or more sub sections.

Slots

identifier

A character representing the unique identifier of the assessment test. By default, it is generated as 'id_test_dddd', where dddd represents random digits.

title

A character representing the title of the test. By default, it takes the value of the identifier.

points

Do not use directly; the maximum number of points for the exam/test. It is calculated automatically as a sum of points of included tasks.

test_part_identifier

A character representing the identifier of the test part.

navigation_mode

A character value, optional, determining the general paths that the candidate may have during the exam. Possible values:

• "linear" - candidate is not allowed to return to the previous questions.

• "nonlinear" - candidate is free to navigate. This is used by default.

submission_mode

A character value, optional, determining when the candidate's responses are submitted for response processing. Possible values:

• "individual" - submit candidates' responses on an item-by-item basis. This is used by default.

• "simultaneous" - candidates' responses are submitted all together by the end of the test.

section

A list containing one or more AssessmentSection objects.

time_limit

A numeric value, optional, controlling the amount of time in minutes which a candidate is allowed for this part of the test.

max_attempts

A numeric value, optional, enabling the maximum number of attempts that a candidate is allowed to make.

allow_comment

A boolean value, optional, allowing candidates to leave comments on each question.

rebuild_variables

A boolean value, optional, allowing variables to be recalculated and the order of choices to be reshuffled for each item attempt.

fallback_titles

A character value, optional, controlling how titles are assigned when no explicit title is provided. Possible values are "filename" (use filenames as titles) and "generic" (use generic labels such as "Section 1", "Section 1.2", or "Task 1.2.1"). Default is "generic".

academic_grading

A named numeric vector that defines the grade table shown to the candidate as feedback at the end of the test.

Each grade corresponds to the minimum percentage score required to achieve it. A helper function german_grading() is available to generate a common German grading scheme.

The default is NULL, which means that no grading table is shown. To display a grading table, provide a named numeric vector or use german_grading().

grade_label

A character value, optional, representing a short message to display with a grade in the final feedback. For multilingual usage, it has to be a named vector with two-letter ISO language codes as names (e.g., c(en="Grade", de="Note")); during test creation, it takes the value for the language of the operating system. Default is c(en="Grade", de="Note").

table_label

A character value, optional, representing a concise message to display as the column title of the grading table in the final feedback. For multilingual usage, it has to be a named vector with two-letter ISO language codes as names (e.g., c(en="Grade", de="Note")); during test creation, it takes the value for the language of the operating system. Default is c(en="Grade", de="Note").

stylesheet_path

A character value, optional, specifying the path to a custom CSS stylesheet. If provided, the stylesheet is included at the assessment test level and applied during rendering. When academic_grading is set, the default stylesheet styles/rqti.css is included automatically; a user-defined stylesheet is added in addition and may override default styles.

metadata

An object of class QtiMetadata that holds metadata information about the test.

show_test_time

A boolean value, optional, determining whether to show the candidate's elapsed processing time without a time limit. Default is FALSE.

calculator

A character value, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific".

mark_items

A boolean value, optional, determining whether to allow candidates to mark questions. Default is TRUE.

keep_responses

A boolean value, optional, determining whether to save the candidate's answers from the previous attempt. Default is FALSE.

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

See Also

AssessmentSection, AssessmentTest, test(), test4opal(), section().

Examples

# This example creates test 'exam' with one section 'exam_section' which
# consists of two questions/tasks: essay and single choice types
task1 <- new("Essay", prompt = "Test task", title = "Essay",
             identifier = "q1")
task2 <- new("SingleChoice", prompt = "Test task", title = "SingleChoice",
             choices = c("A", "B", "C"), identifier = "q2")
exam_section <- new("AssessmentSection", identifier = "sec_id",
                    title = "section", assessment_item = list(task1, task2))
exam <- new("AssessmentTestOpal",
            identifier = "id_test_1234",
            title = "Example of Exam",
            navigation_mode = "linear",
            submission_mode = "individual",
            section = list(exam_section),
            time_limit = 90,
            max_attempts = 1,
            grade_label = "Preliminary grade",
            show_test_time = TRUE,
            calculator = "scientific-calculator",
            mark_items = TRUE,
            files = "text_book.pdf")

Create an object AssessmentTestOpenOlat

Description

Create an AssessmentTestOpenOlat rqti-object.

Usage

assessmentTestOpenOlat(
  section,
  identifier = generate_id(type = "test"),
  title = identifier,
  time_limit = NULL,
  max_attempts = 1L,
  fallback_titles = "generic",
  academic_grading = NULL,
  grade_label = c(en = "Grade", de = "Note"),
  table_label = c(en = "Grade", de = "Note"),
  navigation_mode = "nonlinear",
  submission_mode = "individual",
  allow_comment = TRUE,
  rebuild_variables = TRUE,
  metadata = qtiMetadata(),
  points = NA_real_,
  cancel = FALSE,
  suspend = FALSE,
  scoreprogress = FALSE,
  questionprogress = FALSE,
  maxscoreitem = TRUE,
  menu = TRUE,
  titles = TRUE,
  notes = FALSE,
  hidelms = TRUE,
  hidefeedbacks = FALSE,
  blockaftersuccess = FALSE,
  attempts = 1L,
  anonym = FALSE,
  manualcorrect = FALSE
)

Arguments

Value

An AssessmentTestOpenOlat object.

See Also

test(), section(), assessmentTest(), AssessmentTest, AssessmentSection

Examples

sc <- sc <- singleChoice(prompt = "Question", choices = c("A", "B", "C"))
es <- new("Essay", prompt = "Question")
s <- section(c(sc, es), title = "Section with nonrandomized tasks")
t <- assessmentTestOpenOlat(list(s), title = "Example of the Exam")

Description

Class AssessmentTestOpenOlat is responsible for creating XML exam files according to the QTI 2.1 standard for LMS OpenOlat.

Details

Test consists of one or more sections. Each section can have one or more questions/tasks and/or one or more sub sections.

Slots

identifier

A character representing the unique identifier of the assessment test. By default, it is generated as 'id_test_dddd', where dddd represents random digits.

title

A character representing the title of the test. By default, it takes the value of the identifier.

points

Do not use directly; the maximum number of points for the exam/test. It is calculated automatically as a sum of points of included tasks.

test_part_identifier

A character representing the identifier of the test part.

navigation_mode

A character value, optional, determining the general paths that the candidate may have during the exam. Possible values:

• "linear" - candidate is not allowed to return to the previous questions.

• "nonlinear" - candidate is free to navigate. This is used by default.

submission_mode

A character value, optional, determining when the candidate's responses are submitted for response processing. Possible values:

• "individual" - submit candidates' responses on an item-by-item basis. This is used by default.

• "simultaneous" - candidates' responses are submitted all together by the end of the test.

section

A list containing one or more AssessmentSection objects.

time_limit

A numeric value, optional, controlling the amount of time in minutes which a candidate is allowed for this part of the test.

max_attempts

A numeric value, optional, enabling the maximum number of attempts that a candidate is allowed to make.

allow_comment

A boolean value, optional, allowing candidates to leave comments on each question.

rebuild_variables

A boolean value, optional, allowing variables to be recalculated and the order of choices to be reshuffled for each item attempt.

fallback_titles

A character value, optional, controlling how titles are assigned when no explicit title is provided. Possible values are "filename" (use filenames as titles) and "generic" (use generic labels such as "Section 1", "Section 1.2", or "Task 1.2.1"). Default is "generic".

academic_grading

A named numeric vector that defines the grade table shown to the candidate as feedback at the end of the test.

Each grade corresponds to the minimum percentage score required to achieve it. A helper function german_grading() is available to generate a common German grading scheme.

The default is NULL, which means that no grading table is shown. To display a grading table, provide a named numeric vector or use german_grading().

grade_label

A character value, optional, representing a short message to display with a grade in the final feedback. For multilingual usage, it has to be a named vector with two-letter ISO language codes as names (e.g., c(en="Grade", de="Note")); during test creation, it takes the value for the language of the operating system. Default is c(en="Grade", de="Note").

table_label

A character value, optional, representing a concise message to display as the column title of the grading table in the final feedback. For multilingual usage, it has to be a named vector with two-letter ISO language codes as names (e.g., c(en="Grade", de="Note")); during test creation, it takes the value for the language of the operating system. Default is c(en="Grade", de="Note").

stylesheet_path

A character value, optional, specifying the path to a custom CSS stylesheet. If provided, the stylesheet is included at the assessment test level and applied during rendering. When academic_grading is set, the default stylesheet styles/rqti.css is included automatically; a user-defined stylesheet is added in addition and may override default styles.

metadata

An object of class QtiMetadata that holds metadata information about the test.

cancel

A logical value, optional, indicating whether participants are allowed to cancel an exam after starting it. Default is FALSE.

suspend

A logical value, optional, indicating whether participants are allowed to suspend an exam after starting it and continue later. Default is FALSE.

scoreprogress

A logical value, optional, indicating whether the progress of the score achieved so far should be displayed during the exam. Default is FALSE.

questionprogress

A logical value, optional, indicating whether the number of solved questions should be displayed during the exam. Default is FALSE.

maxscoreitem

A logical value, optional, indicating whether the maximum score of an item should be displayed. Default is TRUE.

menu

A logical value, optional, indicating whether the menu should be displayed during the exam. Default is TRUE.

titles

A logical value, optional, indicating whether question titles should be displayed during the exam. Default is TRUE.

notes

A logical value, optional, indicating whether participants can take notes in OpenOlat during the exam. Default is FALSE.

hidelms

A logical value, optional, indicating whether access to the OpenOlat learning management system should be hidden during the exam. Default is TRUE.

hidefeedbacks

A logical value, optional, indicating whether feedback should be hidden. Default is FALSE.

blockaftersuccess

A logical value, optional, indicating whether the exam should be blocked after successful completion. Default is FALSE.

attempts

An integer value, optional, indicating how many attempts are allowed for the exam as a whole. Default is 1.

anonym

A logical value, optional, indicating whether anonymous users are allowed to take the exam. Default is FALSE.

manualcorrect

A logical value, optional, indicating whether points and pass/fail status should be evaluated manually. Default is FALSE.

See Also

AssessmentSection, AssessmentTest, section().

Examples

# This example creates test 'exam' with one section 'exam_section' which
# consists of two questions/tasks: essay and single choice types
task1 <- new("Essay", prompt = "Test task", title = "Essay",
             identifier = "q1")
task2 <- new("SingleChoice", prompt = "Test task", title = "SingleChoice",
             choices = c("A", "B", "C"), identifier = "q2")
exam_section <- new("AssessmentSection", identifier = "sec_id",
                    title = "section", assessment_item = list(task1, task2))
exam <- new("AssessmentTestOpenOlat",
            identifier = "id_test_1234",
            title = "Example of Exam",
            navigation_mode = "linear",
            submission_mode = "individual",
            section = list(exam_section),
            time_limit = 90,
            max_attempts = 1,
            grade_label = "Preliminary grade")

Description

A generic function to handle authentication with a Learning Management System (LMS).

The method to handle authentication with LMS.

Usage

authLMS(object, ...)

## S4 method for signature 'LMS'
authLMS(object, ...)

Arguments

Description

Generic function for tags that contain assessmentSection in assessmentTest

Usage

buildAssessmentSection(object, folder = NULL, verify = FALSE)

## S4 method for signature 'AssessmentItem'
buildAssessmentSection(object, folder)

## S4 method for signature 'AssessmentSection'
buildAssessmentSection(object, folder = NULL, verify = FALSE)

## S4 method for signature 'character'
buildAssessmentSection(object, folder = NULL, verify = FALSE)

Arguments

Description

Abstract class Choice is not meant to be instantiated directly; instead, it serves as a base for derived classes SingleChoice and MultipleChoice.

Slots

choices

A character vector defining a set of answer options in the question.

choice_identifiers

A character vector, optional, containing a set of identifiers for answers. By default, identifiers are generated automatically according to the template "ChoiceD", where D is a letter representing the alphabetical order of the answer in the list.

shuffle

A boolean value indicating whether to randomize the order in which the choices are initially presented to the candidate. Default is TRUE.

orientation

A character, determining whether to place answers in vertical or horizontal mode. Possible values:

• "vertical" - Default.

• "horizontal"

Create object CorrectFeedback

Description

Create object CorrectFeedback

Usage

correctFeedback(content = list(), title = character(0), show = TRUE)

Arguments

Value

An object of class CorrectFeedback

Examples

cfb <- correctFeedback(content = "Some comments", title = "Feedback")

Description

Class CorrectFeedback is responsible for delivering feedback messages to the candidate in case of a correct answer on the entire exercise.

Slots

outcome_identifier

A character representing the unique identifier of the outcome declaration variable that relates to feedback. Default is "FEEDBACKMODAL".

show

A boolean value, optional, determining whether to show (TRUE) or hide (FALSE) the modal feedback. Default is TRUE.

title

A character value, optional, representing the title of the modal feedback window.

content

A list of character content to form the text of the modal feedback, which can include HTML tags.

identifier

A character value representing the identifier of the modal feedback item. Default is "correct". cfb <- new("CorrectFeedback", title = "Right answer", content = list("Some demonstration"))

Description

create_assessment_item() creates html structure with AssessmentItem root element (shiny.tag) for xml qti task description according QTI 2.1

Usage

create_assessment_item(object)

Arguments

Value

A list() with a shiny.tag class

Description

Create XML file for question specification

Usage

create_qti_task(object, dir = NULL, verification = FALSE)

Arguments

Value

xml document.

Description

Create XML file for exam test specification

Usage

create_qti_test(object, path = ".", verification = FALSE, zip_only
  = FALSE)

Arguments

Value

xml document.

Create rqti S4 AssessmentItem Object from Rmd

Description

Generates an rqti S4 AssessmentItem object (SingleChoice, MultipleChoice, Essay, Entry, Ordering, OneInRowTable, OneInColTable, MultipleChoiceTable, DirectedPair) from an Rmd file.

Usage

create_question_object(file)

Arguments

Value

One of the rqti S4 AssessmentItem objects: SingleChoice, MultipleChoice, Essay, Entry, Ordering, OneInRowTable, OneInColTable, MultipleChoiceTable, or DirectedPair.

CSS in YAML

Use stylesheet_path: styles.css for a CSS file (or a YAML sequence of files). Relative paths are resolved against the Rmd file's directory. Use a YAML literal block ⁠css: |⁠ for CSS text. When both are supplied, files are linked in the supplied order, followed by the CSS text. Stylesheets are linked from the assessment item and included in QTI ZIPs and their manifests. Standalone XML exports write CSS beside the XML in a ⁠styles/items/⁠ subdirectory; keep that directory with the XML. These fields do not convert inline HTML style attributes to classes. CSS references such as url(...) and ⁠@import⁠ are not collected or rewritten; use self-contained stylesheets. Rendering depends on the delivery platform's CSS support.

Examples

create_question_object("file.Rmd")

Description

Generic function for creating assessmentTest element for XML document of specification the test following the QTI schema v2.1

Usage

createAssessmentTest(object, folder, verify = FALSE)

## S4 method for signature 'AssessmentTest'
createAssessmentTest(object, folder, verify = FALSE)

## S4 method for signature 'AssessmentTestOpal'
createAssessmentTest(object, folder, verify = FALSE)

Arguments

Description

Generic function for creating additional configuration file for the archive with test

Usage

createConfigurationFile(object, output)

## S4 method for signature 'AssessmentTest'
createConfigurationFile(object, output)

## S4 method for signature 'AssessmentTestOpenOlat'
createConfigurationFile(object, output)

Arguments

Description

This method creates a group in a course on the Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

This method creates a learning group in an LMS Opal course using OPAL's GroupVO XML representation. The group name must be unique within the course. invitationEnabled controls whether new group members receive an invitation that has to be accepted; signoutEnabled controls whether members may leave the group themselves.

Usage

createCourseGroup(object, course_id, name, ...)

## S4 method for signature 'missing'
createCourseGroup(object, course_id, name, ...)

## S4 method for signature 'Opal'
createCourseGroup(
  object,
  course_id,
  name,
  description = "",
  minParticipants = 0,
  maxParticipants = 0,
  invitationEnabled = TRUE,
  signoutEnabled = TRUE
)

Arguments

Value

A data frame with the created group attributes.

A one-row data frame with the created group attributes, or NULL when OPAL rejects the request.

Examples

group <- createCourseGroup("89068111333293", "Topic 5")


group <- createCourseGroup(
    "89068111333293",
    "Topic 5",
    description = "Group for topic 5",
    minParticipants = 1,
    maxParticipants = 1,
    invitationEnabled = FALSE,
    signoutEnabled = FALSE
)

Description

Generic function for creating itemBody element for XML document of specification the question following the QTI schema v2.1

Usage

createItemBody(object)

## S4 method for signature 'DirectedPair'
createItemBody(object)

## S4 method for signature 'Entry'
createItemBody(object)

## S4 method for signature 'Essay'
createItemBody(object)

## S4 method for signature 'MultipleChoice'
createItemBody(object)

## S4 method for signature 'MultipleChoiceTable'
createItemBody(object)

## S4 method for signature 'OneInColTable'
createItemBody(object)

## S4 method for signature 'OneInRowTable'
createItemBody(object)

## S4 method for signature 'Ordering'
createItemBody(object)

## S4 method for signature 'SingleChoice'
createItemBody(object)

Arguments

Description

Create an element of metadata

Usage

createMetadata(object)

## S4 method for signature 'QtiContributor'
createMetadata(object)

## S4 method for signature 'AssessmentItem'
createMetadata(object)

## S4 method for signature 'AssessmentTest'
createMetadata(object)

Arguments

Description

Generic function for creating outcomeDeclaration element for XML document of specification the question following the QTI schema v2.1

Usage

createOutcomeDeclaration(object)

## S4 method for signature 'AssessmentItem'
createOutcomeDeclaration(object)

## S4 method for signature 'AssessmentTest'
createOutcomeDeclaration(object)

## S4 method for signature 'Entry'
createOutcomeDeclaration(object)

## S4 method for signature 'Gap'
createOutcomeDeclaration(object)

## S4 method for signature 'MultipleChoice'
createOutcomeDeclaration(object)

## S4 method for signature 'SingleChoice'
createOutcomeDeclaration(object)

Arguments

Description

Create XML or zip file for question specification

Usage

createQtiTask(object, dir = ".", verification = FALSE, zip = FALSE)

## S4 method for signature 'AssessmentItem'
createQtiTask(object, dir = ".", verification = FALSE, zip = FALSE)

## S4 method for signature 'character'
createQtiTask(object, dir = getwd(), verification = FALSE, zip = FALSE)

Arguments

Value

A path to xml or zip file.

Examples

essay <- new("Essay", prompt = "Test task", title = "Essay")
## Not run: 
# creates folder with XML (side effect)
createQtiTask(essay, "result")
# creates folder with zip (side effect)
createQtiTask(essay, "result", zip = TRUE)

## End(Not run)

Description

Create zip-archive of the qti test specification

Usage

createQtiTest(object, dir = NULL, verification = FALSE, zip_only =
  FALSE)

## S4 method for signature 'AssessmentItem'
createQtiTest(object, dir = ".", verification = FALSE, zip_only = FALSE)

## S4 method for signature 'AssessmentTest'
createQtiTest(object, dir = getwd(), verification = FALSE, zip_only = FALSE)

## S4 method for signature 'character'
createQtiTest(object, dir = getwd())

Arguments

Value

A path to zip and xml files.

Examples

essay <- new("Essay", prompt = "Test task", title = "Essay",
             identifier = "q1")
sc <- new("SingleChoice", prompt = "Test task", title = "SingleChoice",
          choices = c("A", "B", "C"), identifier = "q2")
exam_section <- new("AssessmentSection", identifier = "sec_id",
                   title = "section", assessment_item = list(essay, sc))
exam <- new("AssessmentTestOpal", identifier = "id_test",
           title = "some title", section = list(exam_section))
## Not run: 
# creates folder with zip (side effect)
createQtiTest(exam, "exam_folder", "TRUE")

## End(Not run)

Description

Generic function for creating responseDeclaration element for XML document of specification the question following the QTI schema v2.1

Usage

createResponseDeclaration(object)

## S4 method for signature 'AssessmentItem'
createResponseDeclaration(object)

## S4 method for signature 'MatchTable'
createResponseDeclaration(object)

## S4 method for signature 'Entry'
createResponseDeclaration(object)

## S4 method for signature 'Essay'
createResponseDeclaration(object)

## S4 method for signature 'InlineChoice'
createResponseDeclaration(object)

## S4 method for signature 'MultipleChoice'
createResponseDeclaration(object)

## S4 method for signature 'MultipleChoiceTable'
createResponseDeclaration(object)

## S4 method for signature 'NumericGap'
createResponseDeclaration(object)

## S4 method for signature 'Ordering'
createResponseDeclaration(object)

## S4 method for signature 'SingleChoice'
createResponseDeclaration(object)

## S4 method for signature 'TextGap'
createResponseDeclaration(object)

Arguments

Description

Generic function for creating responseProcessing element for XML document of specification the question following the QTI schema v2.1

Usage

createResponseProcessing(object)

## S4 method for signature 'AssessmentItem'
createResponseProcessing(object)

## S4 method for signature 'Entry'
createResponseProcessing(object)

## S4 method for signature 'Essay'
createResponseProcessing(object)

## S4 method for signature 'Gap'
createResponseProcessing(object)

## S4 method for signature 'MultipleChoice'
createResponseProcessing(object)

## S4 method for signature 'NumericGap'
createResponseProcessing(object)

## S4 method for signature 'Ordering'
createResponseProcessing(object)

## S4 method for signature 'SingleChoice'
createResponseProcessing(object)

## S4 method for signature 'TextGapOpal'
createResponseProcessing(object)

Arguments

Description

Generic function for creating a set of html elements to display question for XML document of specification the question following the QTI schema v2.1

Usage

createText(object)

## S4 method for signature 'Gap'
createText(object)

## S4 method for signature 'InlineChoice'
createText(object)

## S4 method for signature 'character'
createText(object)

Arguments

Description

Generic function for creating zip archive with set of XML documents of specification the test following the QTI schema v2.1

Usage

createZip(object, input, output, file_name, zip_only)

## S4 method for signature 'AssessmentTest'
createZip(object, input, output, file_name, zip_only)

## S4 method for signature 'AssessmentTestOpal'
createZip(object, input, output, file_name, zip_only)

Arguments

Create object DirectedPair

Description

Create object DirectedPair

Usage

directedPair(
  identifier = generate_id(),
  title = identifier,
  content = list(),
  prompt = "",
  points = 1,
  rows,
  rows_identifiers,
  cols,
  cols_identifiers,
  answers_identifiers,
  answers_scores = NA_real_,
  shuffle = TRUE,
  shuffle_rows = TRUE,
  shuffle_cols = TRUE,
  feedback = list(),
  orientation = "vertical",
  calculator = NA_character_,
  files = NA_character_
)

Arguments

Value

An object of class DirectedPair

Examples

dp_min <- directedPair(content = "<p>\"Directed pairs\" task</p>",
                       rows = c("alfa", "beta", "gamma"),
                       rows_identifiers = c("a", "b", "g"),
                       cols = c("A", "B", "G;"),
                       cols_identifiers = c("as", "bs", "gs"),
                       answers_identifiers = c("a as", "b bs", 'g gs'))

dp <- directedPair(identifier = "id_task_1234",
                   title = "Directed Pair Task",
                   content = "<p>\"Directed pairs\" task</p>",
                   prompt = "Plain text, can be used instead of the content",
                   rows = c("alfa", "beta", "gamma"),
                   rows_identifiers = c("a", "b", "g"),
                   cols = c("A", "B", "G"),
                   cols_identifiers = c("as", "bs", "gs"),
                   answers_identifiers = c("a as", "b bs", "g gs"),
                   answers_scores = c(1, 0.5, 0.1),
                   shuffle_rows = FALSE,
                   shuffle_cols = TRUE,
                   orientation = "horizontal")

Description

Class DirectedPair is responsible for creating assessment tasks according to the QTI 2.1 standard, where a candidate has to make binary associations between answer options.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

rows

A character vector specifying answer options as row names in the table or the first elements in couples in DirectedPair.

rows_identifiers

A character vector, optional, specifying identifiers for answer options defined in rows of the table or identifiers of the first elements in couples in DirectedPair.

cols

A character vector specifying answer options as column headers in the table or the second elements in couples in DirectedPair.

cols_identifiers

A character vector, optional, specifying identifiers for answer options defined in columns of the table or identifiers of the second elements in couples in DirectedPair.

answers_identifiers

A character vector specifying couples of identifiers that combine the correct answers.

answers_scores

A numeric vector, optional, where each number determines the number of points awarded to a candidate if they select the corresponding answer. If not assigned, the individual values for correct answers are calculated from the task points and the number of correct options.

shuffle

A boolean value, optional, determining whether to randomize the order in which the choices are initially presented to the candidate. Default is TRUE.

shuffle_rows

A boolean value, optional, determining whether to randomize the order of the choices only in rows. Default is TRUE.

shuffle_cols

A boolean value, optional, determining whether to randomize the order of the choices only in columns. Default is TRUE.

orientation

A character, optional, determining whether to place answers in vertical or horizontal mode. Possible values:

• "vertical" - Default.

• "horizontal"

Examples

dp <- new("DirectedPair",
          identifier = "id_task_1234",
          title = "Directed pair",
          content = list("<p>\"Directed pairs\" task</p>"),
          points = 5,
          rows = c("row1", "row2", "row3"),
          rows_identifiers = c("a", "b", "c"),
          cols = c("alfa", "beta", "gamma"),
          cols_identifiers = c("k", "l", "m"),
          answers_identifiers = c("a k", "b l", 'c m'),
          shuffle = TRUE,
          orientation = "vertical")

Description

Create YAML string for InlineChoice object (dropdown list)

Usage

dropdown(
  choices,
  solution_index = 1,
  points = 1,
  shuffle = TRUE,
  response_identifier = NULL
)

Arguments

Value

A character string mapped as YAML.

See Also

gap_text(), gap_numeric(), mdlist()

Examples

dropdown(c("Option A", "Option B"), response_identifier = "task_dd_list")

Create object Entry

Description

Create object Entry

Usage

entry(
  identifier = generate_id(),
  title = identifier,
  content = list(),
  prompt = "",
  points = 1,
  feedback = list(),
  calculator = NA_character_,
  files = NA_character_
)

Arguments

Value

An object of class Entry

See Also

[textGap()][numericGap()][textGapOpal()]

Examples

gap_min <- entry(content = list("Question and Test Interoperability",
                               textGap("QTI")))

gap <- entry(identifier = "id_task_1234",
           title = "Essay Task",
                   content = list("Question and Test Interoperability:",
                                  textGap("QTI")),
                   prompt = "Plain text, can be used instead of content",
                   points = 2,
                   feedback = list(new("ModalFeedback",
                                   content = list("Model answer"))),
                   calculator = "scientific-calculator",
                   files = "text_book.pdf")

Description

Class Entry is responsible for creating assessment tasks according to the QTI 2.1 standard. These tasks include one or more instances of text input fields (with numeric or text answers) or dropdown lists.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

See Also

NumericGap, TextGap, TextGapOpal, InlineChoice

Examples

entry_gaps <- new("Entry", content = list("<p>In mathematics, the common
logarithm is the logarithm with base", new("NumericGap",
                                           response_identifier = "numeric_1",
                                           solution = 10,
                                           placeholder = "it is a number"),
". It is also known as the decimal", new("TextGap",
                                         response_identifier = "text_1",
                                         solution = "logarithm",
                                         placeholder = "it is a text"),
 ".</p>"),
                   title = "entry with number and text in answers",
                   identifier = "entry_example")
entry_dropdown <- new("Entry", content = list("<p>In mathematics, the common
logarithm is the logarithm with base", new("InlineChoice",
                                           response_identifier = "numeric_1",
                                           choices = c("10", "7", "11")),
". It is also known as the decimal", new("InlineChoice",
                                         response_identifier = "text_1",
                                         choices = c("logarithm", "limit")),
 ".</p>"),
                   title = "entry with dropdown lists for answers",
                   identifier = "entry_example")

Create object Essay

Description

Create object Essay

Usage

essay(
  identifier = generate_id(),
  title = identifier,
  content = list(),
  prompt = "",
  points = 1,
  feedback = list(),
  expected_length = length_expected(feedback),
  expected_lines = lines_expected(feedback),
  words_max = max_words(feedback),
  words_min = NA_integer_,
  data_allow_paste = TRUE,
  calculator = NA_character_,
  files = NA_character_
)

Arguments

Value

An object of class Essay

Examples

es_min <- essay(content = list("<h2>Open question</h2>", "Write your answer here"))

es <- essay(identifier = "id_task_1234",
           title = "Essay Task",
           content = "<h2>Open question</h2> Write your answer here",
           prompt = "Plain text, can be used instead of content",
           points = 2,
           expected_length = 100,
           expected_lines = 5,
           words_max = 100,
           words_min = 1,
           data_allow_paste = TRUE,
           feedback = list(new("ModalFeedback",
                            content = list("Model answer"))),
           calculator = "scientific-calculator",
           files = "text_book.pdf")

Description

Class Essay is responsible for creating essay type of assessment task according to QTI 2.1.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

expected_length

A numeric, optional. Responsible for setting the size of the text input field in the content delivery engine.

expected_lines

A numeric, optional. Responsible for setting the number of rows of the text input field in the content delivery engine.

words_max

A numeric, optional. Responsible for setting the maximum number of words that a candidate can write in the text input field.

words_min

A numeric, optional. Responsible for setting the minimum number of words that a candidate should write in the text input field.

data_allow_paste

A logical, optional. Determines whether it is possible for a candidate to copy text into the text input field. Default is TRUE. Only works on OPAL and OpenOlat.

Note

If 'ModalFeedback' is given, default values for slots related to the text input field are calculated automatically.

Examples

es <- new("Essay",
          identifier = "id_task_1234",
          title = "Essay Task",
          content = list("<p>Develop some idea and write it down in
                                  the text field</p>"),
          prompt = "Write your answer in text field",
          points = 1,
          feedback = list(),
          calculator = "scientific-calculator",
          files = "text_book.pdf",
          expected_length = 100,
          expected_lines = 5,
          words_max = 200,
          words_min = 10,
          data_allow_paste = FALSE)

Description

Helper function for using tasks written in the exams Rmd format inside rqti sections. The function converts the given Rmd file with exams::exams2qti21() and returns the path to the generated XML file.

Usage

exams_task(path, title = NULL)

Arguments

Details

This function is mainly useful when exams tasks need to be combined with native rqti tasks in one section, for example: section(exams_task(path_to_file, title = "Exams task")).

Value

Character string. Path to the QTI 2.1 XML file generated by exams::exams2qti21() in a temporary directory.

Examples

path <- system.file("exams", "example.Rmd", package = "rqti")
section(exams_task(path, title = "Exams task"))

Description

The function extract_results() takes Opal zip archive "Export results" or xml file and creates two kinds of data frames (according to parameter 'level'), see the 'Details' section.

Usage

extract_results(file, level = "task", hide_filename = TRUE)

read_qti(file, level = "task", hide_filename = TRUE)

Arguments

Value

A data frame with attributes of the candidates' outcomes and results. variables.

Note

1.With option level = "task" data frame consists of columns:

• 'file' - name of the xml file with test results (to identify candidate)

• 'date' - date and time of test

• 'id_question' - question item identifier

• 'duration' - time in sec. what candidate spent on this item

• 'score_candidate' - points that were given to candidate after evaluation

• 'score_max' - max possible score for this question

• 'is_answer_given' - TRUE if candidate gave the answer on question, otherwise FALSE

• 'title' - the values of attribute 'title' of assessment items

• 'candidate_comment' - candidate's comment for the item (if available).

• 'scorer_comment' - scorer's comment for manually scored items (if available).

2.With option level = "item" data frame consists of columns:

• 'file' - name of the xml file with test results (to identify candidate)

• 'date' - date and time of test

• 'id_question' - question item identifier

• 'base_type' - type of answer (identifier, directedPair, string, float or integer)

• 'cardinalities' - defines whether this question is single, multiple or ordered -value

• 'qti_type' - specifies the type of the task

• 'id_answer' - identifier of each response variable

• 'expected_response' - values that considered as right responses for question

• 'candidate_response' - values that were given by candidate

• 'score_candidate' - - points that were given to candidate after evaluation

• 'score_max' - max possible score for this question item

• 'is_response_correct' - TRUE if candidate gave the right response, otherwise FALSE

• 'title' - the values of attribute 'title' of assessment items

• 'candidate_comment' - candidate's comment for the item (if available).

• 'scorer_comment' - scorer's comment for manually scored items (if available).

Examples

file <- system.file("test_results.zip", package = "rqti")
df <- extract_results(file, level = "item")

Description

Create YAML string for NumericGap object

Usage

gap_numeric(
  solution,
  tolerance = 0,
  tolerance_type = "absolute",
  points = 1,
  response_identifier = NULL,
  include_lower_bound = TRUE,
  include_upper_bound = TRUE,
  expected_length = size_gap(solution),
  placeholder = NULL
)

Arguments

Value

A character string mapped as YAML.

See Also

gap_text(), dropdown(), mdlist()

Examples

gap_numeric(5.0, tolerance = 10, tolerance_type = "relative")

Description

Create YAML string for TextGap object

Usage

gap_text(
  solution,
  tolerance = NULL,
  case_sensitive = FALSE,
  points = 1,
  response_identifier = NULL,
  expected_length = size_gap(solution),
  placeholder = NULL
)

Arguments

Value

A character string mapped as YAML.

See Also

gap_numeric(), dropdown(), mdlist()

Examples

gap_text(c("Solution", "Solutions"), tolerance = 2)

Description

Abstract class Gap is not meant to be instantiated directly; instead, it serves as a base for derived classes such as NumericGap, TextGap, TextGapOpal and InlineChoice.

Slots

response_identifier

A character value representing an identifier for the answer. By default, it is generated as 'id_gap_dddd', where dddd represents random digits.

points

A numeric value, optional, representing the number of points for this gap. Default is 1.

placeholder

A character value, optional, used to place helpful text in the text input field in the content delivery engine.

expected_length

A numeric value, optional, used to set the size of the text input field in the content delivery engine.

See Also

NumericGap, TextGap, TextGapOpal and InlineChoice.

Description

A helper function that returns a named numeric vector representing a common German grading scheme. The names correspond to grades and the values define the minimum proportion of points required to achieve the respective grade.

Usage

german_grading()

Value

A named numeric vector with grades as names and minimum score proportions as values.

Examples

german_grading()

Description

Generic function for

Usage

getAssessmentItems(object)

## S4 method for signature 'AssessmentItem'
getAssessmentItems(object)

## S4 method for signature 'AssessmentSection'
getAssessmentItems(object)

## S4 method for signature 'character'
getAssessmentItems(object)

Arguments

Description

Get value of the slot 'calculator'

Usage

getCalculator(object)

## S4 method for signature 'AssessmentItem'
getCalculator(object)

## S4 method for signature 'AssessmentSection'
getCalculator(object)

## S4 method for signature 'character'
getCalculator(object)

Arguments

Description

Get list of contributors values

Usage

getContributors(object)

## S4 method for signature 'AssessmentItem'
getContributors(object)

## S4 method for signature 'AssessmentSection'
getContributors(object)

## S4 method for signature 'character'
getContributors(object)

Arguments

Description

This method retrieves current assessment data for a course element on a Learning Management System (LMS), including score, maximum score, passed status, and attempts. If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

This method retrieves current assessment data for a course element on LMS Opal by course id and course element id. It returns user metadata together with score, maximum score, passed status, and attempts. If user_id is supplied, the query is restricted to that user login name or email address.

Usage

getCourseAssessment(object, course_id, node_id, user_id = NULL, ...)

## S4 method for signature 'missing'
getCourseAssessment(object, course_id, node_id, user_id = NULL, ...)

## S4 method for signature 'Opal'
getCourseAssessment(object, course_id, node_id, user_id = NULL)

Arguments

Value

A data frame with assessment scores.

A data frame with assessment scores. Each row represents a user and contains identity id, user id, user name/email, score, maximum score, passed status, and attempts.

Examples

assessment <- getCourseAssessment("89068111333293", "1617337826161777006")


assessment <- getCourseAssessment("89068111333293", "1617337826161777006")

Description

This method gets elements of the user's course by its courseId on Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getCourseElements(object, course_id)

## S4 method for signature 'missing'
getCourseElements(object, course_id)

## S4 method for signature 'Opal'
getCourseElements(object, course_id)

Arguments

Value

A data frame with the elements of the course.

A data frame with the data of the elements of the course (fields: nodeId, shortTitle, shortName, longTitle) on LMS Opal.

Description

This method retrieves groups from a course on the Learning Management System (LMS) by its course id. It returns a data frame with all accessible attributes of the groups. If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

This method retrieves groups from a course on LMS Opal by its course id. The groups are returned as a data frame with all accessible attributes, such as group id, name, description, participant limits, and group settings. If no Opal connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getCourseGroups(object, course_id)

## S4 method for signature 'missing'
getCourseGroups(object, course_id)

## S4 method for signature 'Opal'
getCourseGroups(object, course_id)

Arguments

Value

A data frame with all accessible attributes of the course groups.

A data frame with course groups and their attributes.

Examples

groups <- getCourseGroups("89068111333293")


groups <- getCourseGroups("89068111333293")

Description

This method retrieves zip with course results by its resource id and node id on Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getCourseResult(object, resource_id, node_id, path_outcome = ".", ...)

## S4 method for signature 'missing'
getCourseResult(object, resource_id, node_id, path_outcome = ".", ...)

## S4 method for signature 'Opal'
getCourseResult(
  object,
  resource_id,
  node_id,
  path_outcome = ".",
  rename = TRUE
)

Arguments

Value

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

Examples

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

Description

Get file paths for attachment of test

Usage

getFiles(object)

## S4 method for signature 'AssessmentItem'
getFiles(object)

## S4 method for signature 'AssessmentSection'
getFiles(object)

## S4 method for signature 'character'
getFiles(object)

Arguments

Description

This method retrieves users from a group on the Learning Management System (LMS) by its group id. It returns a data frame with all accessible attributes of the group members. If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

This method retrieves users from a group on LMS Opal by its group id. It returns a data frame with user attributes obtained from the LMS, including user id, login, first name, last name, email, and additional properties (e.g., status). If no Opal connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getGroupUsers(object, group_id)

## S4 method for signature 'missing'
getGroupUsers(object, group_id)

## S4 method for signature 'Opal'
getGroupUsers(object, group_id)

Arguments

Value

A data frame with all accessible attributes of the group members.

A data frame with group users and their attributes. Each row represents a user and may include the following columns:

key

Unique user id.

login

User login name.

firstName

User first name.

lastName

User last name.

email

User email address.

status

User status (e.g., STATUS_ACTIVE).

Examples

groups <- getGroupUsers("89068111333293")


users <- getGroupUsers("89068111333293")

Description

Get identifier

Usage

getIdentifier(object)

## S4 method for signature 'AssessmentItem'
getIdentifier(object)

## S4 method for signature 'AssessmentSection'
getIdentifier(object)

## S4 method for signature 'Gap'
getIdentifier(object)

## S4 method for signature 'character'
getIdentifier(object)

Arguments

Description

This method retrieves data about all resources associated with the current user on the Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getLMSResources(object, ...)

## S4 method for signature 'missing'
getLMSResources(object)

## S4 method for signature 'Opal'
getLMSResources(object)

Arguments

Value

A data frame with attributes of the user's resources.

Description

This method retrieves data about a user's resource by its name on Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getLMSResourcesByName(object, ...)

## S4 method for signature 'missing'
getLMSResourcesByName(object, display_name, rtype = NULL)

## S4 method for signature 'Opal'
getLMSResourcesByName(object, display_name, rtype = NULL)

Arguments

Value

A data frame with attributes of the user's resources.

Examples

df <- getLMSResourcesByName("task_name")

Description

This method creates an URL for user's resource by its name on Learning Management System (LMS). If no LMS connection object is provided, it attempts to guess the connection using default settings (e.g., environment variables). If the connection cannot be established, an error is thrown.

Usage

getLMSResourceURL(object, display_name)

## S4 method for signature 'missing'
getLMSResourceURL(object, display_name)

## S4 method for signature 'Opal'
getLMSResourceURL(object, display_name)

Arguments

Value

A string value of URL.

Description

Get object

Usage

getObject(object)

## S4 method for signature 'AssessmentItem'
getObject(object)

## S4 method for signature 'AssessmentSection'
getObject(object)

## S4 method for signature 'character'
getObject(object)

Arguments

Description

Get points from AssessmentItem object

Usage

getPoints(object)

## S4 method for signature 'AssessmentItem'
getPoints(object)

## S4 method for signature 'AssessmentSection'
getPoints(object)

## S4 method for signature 'MultipleChoice'
getPoints(object)

## S4 method for signature 'SingleChoice'
getPoints(object)

## S4 method for signature 'character'
getPoints(object)

Arguments

Description

Generic function to get and process a different types of question content (text with instances of gaps or dropdown lists) for XML document of specification the question following the QTI schema v2.1

Usage

getResponse(object)

## S4 method for signature 'InlineChoice'
getResponse(object)

## S4 method for signature 'NumericGap'
getResponse(object)

## S4 method for signature 'TextGap'
getResponse(object)

## S4 method for signature 'character'
getResponse(object)

Arguments

Create object InlineChoice

Description

Create object InlineChoice

Usage

inlineChoice(
  choices,
  solution_index = 1,
  response_identifier = generate_id(type = "gap"),
  choices_identifiers = paste0("Choice", LETTERS[seq(choices)]),
  points = 1,
  shuffle = TRUE,
  placeholder = "",
  expected_length = size_gap(choices)
)

Arguments

Value

An object of class InlineChoice

See Also

[entry()][numericGap()][textGap()][textGapOpal()]

Examples

dd_min <- inlineChoice(c("answer1", "answer2", "answer3"))

dd <- inlineChoice(choices = c("answer1", "answer2", "answer3"),
                  solution_index = 2,
                  response_identifier  = "id_gap_1234",
                  choices_identifiers = c("a", "b", "c"),
                  points = 2,
                  shuffle = FALSE,
                  placeholder = "answers",
                  expected_length = 10)

Description

Class InlineChoice is responsible for creating instances of dropdown lists as answer options in Entry type assessment tasks according to the QTI 2.1 standard.

Slots

response_identifier

A character value representing an identifier for the answer. By default, it is generated as 'id_gap_dddd', where dddd represents random digits.

points

A numeric value, optional, representing the number of points for this gap. Default is 1.

placeholder

A character value, optional, used to place helpful text in the text input field in the content delivery engine.

expected_length

A numeric value, optional, used to set the size of the text input field in the content delivery engine.

choices

A character vector containing the answers shown in the dropdown list.

solution_index

A numeric value, optional, representing the index of the correct answer in the options vector. Default is 1.

choices_identifiers

A character vector, optional, containing a set of identifiers for answers. By default, identifiers are generated automatically according to the template "OptionD", where D is a letter representing the alphabetical order of the answer in the list.

shuffle

A boolean value, optional, determining whether to randomize the order in which the choices are initially presented to the candidate. Default is TRUE.

See Also

Entry, NumericGap, TextGap, TextGapOpal

Examples

dd <- new("InlineChoice",
          response_identifier = "id_gap_1234",
          points = 1,
          choices =  c("answer1", "answer2", "answer3"),
          solution_index = 1,
          choices_identifiers = c("OptionA", "OptionB", "OptionC"),
          shuffle = TRUE)

Description

This method checks whether a user is logged into an LMS (Learning Management System) by sending a request to the LMS server and evaluating the response.

This method checks whether a user is logged into an LMS Opal by sending a request to the LMS server and evaluating the response.

Usage

isUserLoggedIn(object)

## S4 method for signature 'Opal'
isUserLoggedIn(object)

Arguments

Value

A logical value (TRUE if the user is logged in, FALSE otherwise).

A logical value (TRUE if the user is logged in, FALSE otherwise).

Description

The LMS class is an abstract representation of a Learning Management System (LMS). It provides a foundation for defining LMS-specific implementations.

Slots

name

A character string representing the name or identifier of the LMS.

api_user

A character string containing the username for authentication.

endpoint

A character string specifying the LMS API endpoint. By default, this value is retrieved from the environment variable RQTI_API_ENDPOINT. To set this variable globally, use: Sys.setenv(RQTI_API_ENDPOINT = 'your_endpoint'), or add it to your .Renviron file for persistence across sessions.

credential_id

A character string identifying the credential set in the operating-system keyring. If omitted, rqti derives the credential service from the endpoint and falls back to its original service name for backward compatibility. RQTI_API_CREDENTIAL_ID or an explicit value can override automatic endpoint-based naming.

session

An internal environment containing connection-specific session state, including the authentication token.

Description

Abstract class MatchTable is not meant to be instantiated directly; instead, it serves as a base for derived classes such as OneInRowTable, OneInColTable, MultipleChoiceTable, and DirectedPair.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

rows

A character vector specifying answer options as row names in the table or the first elements in couples in DirectedPair.

rows_identifiers

A character vector, optional, specifying identifiers for answer options defined in rows of the table or identifiers of the first elements in couples in DirectedPair.

cols

A character vector specifying answer options as column headers in the table or the second elements in couples in DirectedPair.

cols_identifiers

A character vector, optional, specifying identifiers for answer options defined in columns of the table or identifiers of the second elements in couples in DirectedPair.

answers_identifiers

A character vector specifying couples of identifiers that combine the correct answers.

answers_scores

A numeric vector, optional, where each number determines the number of points awarded to a candidate if they select the corresponding answer. If not assigned, the individual values for correct answers are calculated from the task points and the number of correct options.

shuffle

A boolean value, optional, determining whether to randomize the order in which the choices are initially presented to the candidate. Default is TRUE.

shuffle_rows

A boolean value, optional, determining whether to randomize the order of the choices only in rows. Default is TRUE.

shuffle_cols

A boolean value, optional, determining whether to randomize the order of the choices only in columns. Default is TRUE.

See Also

OneInRowTable, OneInColTable, MultipleChoiceTable, DirectedPair

Description

Create a markdown list for answer options

Usage

mdlist(vect, solutions = NULL, gaps = NULL)

Arguments

Value

A markdown list.

See Also

gap_text(), gap_numeric(), dropdown()

Examples

#list for multiple choice task
mdlist(c("A", "B", "C"), c(2, 3))
# it returns:
#- A
#- *B*
#- *C*
#list of gaps
mdlist(c("A", "B", "C"), c(2, 3), c(1, 2, 3))
# it returns:
#- A <gap>1</gap>
#- *B* <gap>2</gap>
#- *C* <gap>3</gap>

Create object ModalFeedback

Description

Create object ModalFeedback

Usage

modalFeedback(content = list(), title = character(0), show = TRUE)

Arguments

Value

An object of class ModalFeedback

Examples

fb <- modalFeedback(content = "Model answer", title = "Feedback")

Description

Class ModalFeedback is responsible for delivering feedback messages to the candidate, regardless of whether the answer was correct or incorrect.

Slots

outcome_identifier

A character representing the unique identifier of the outcome declaration variable that relates to feedback. Default is "FEEDBACKMODAL".

show

A boolean value, optional, determining whether to show (TRUE) or hide (FALSE) the modal feedback. Default is TRUE.

title

A character value, optional, representing the title of the modal feedback window.

content

A list of character content to form the text of the modal feedback, which can include HTML tags.

identifier

A character value representing the identifier of the modal feedback item. Default is "modal_feedback".

Examples

fb <- new("ModalFeedback",
          title = "Possible solution",
          content = list("<b>Some explanation</b>"))

Description

Create a scoring specification for multipleChoice() or a multiple-choice Rmd item. These items permit several selected options. For one-answer items, see single_choice_scoring(). Both this helper and the multiple-choice item default to "standard": balanced partial credit equivalent to Youden's J with a zero floor for the usual automatically balanced weights.

Usage

multiple_choice_scoring(method = "standard", ...)

Arguments

Value

A named list for scoring_scheme in multipleChoice(). Passing it to singleChoice() is an error. Plain YAML mappings are interpreted using the item's type.

Methods

Positive entries in the item's points identify correct options, and their sum is the maximum score P. C is the number of correct options and W the number of incorrect options.

The five literature methods are described by Betts et al. Their raw scores are scaled here to the item maximum P. Those five methods and exams use the correct-option set and its total points, rather than the relative magnitudes of positive option weights. standard and weights preserve individual contributions, with the zero-weight handling described above.

Default

balanced scoring and Youden's J: With C > 0 correct options, W > 0 incorrect options, equal correct-option weights, and automatically balanced incorrect-option penalties, the raw normalized score is Youden's J:

$J = \frac{\#\mathrm{correct\ options\ selected}}{C} - \frac{\#\mathrm{incorrect\ options\ selected}}{W}.$

The awarded score is $P\max(0,J)$. Each selected correct option adds P/C and each selected incorrect option subtracts P/W; unchecked options contribute zero. This is the ordinary Rmd default when its correct options share the points equally. The raw J has zero expectation under independent random selection; flooring it at zero does not preserve that expectation. standard also preserves explicit negative option weights. If the positive or negative weights differ from those balanced contributions, the resulting custom weighting is not necessarily Youden's J. standard is the method identifier; Youden's J describes its ordinary balanced special case.

Empty responses and bounds

true_false treats an unchecked option as a false decision, so an empty selection can earn P*W/(C+W). Checkboxes cannot distinguish a deliberate nonselection from an omitted decision. An explicit true/false/omission interaction is a different format. The other methods score an empty response as zero unless otherwise configured. By default negative totals are floored at zero; weights, plus_minus, all_or_nothing, and exams can allow negative scores through their documented settings. Scores never exceed P.

Rmd/YAML

scoring_scheme:
  method: exams
  partial: true
  negative: -0.25
  rule: "false2"

Or use a preset string, for example scoring_scheme: plus_minus. The YAML list is interpreted from type: mpc (or another supported multiple-choice type alias); no function call is needed inside YAML.

References

Betts J, Muntean W, Kim D, Kao S (2022). Evaluating Different Scoring Methods for Multiple Response Items Providing Partial Credit. Educational and Psychological Measurement, 82(1), 151–176. doi:10.1177/0013164421994636.

See Also

multipleChoice(), single_choice_scoring()

Examples

multipleChoice(choices = c("A", "B", "C"), points = c(0.5, 0, 0.5),
  scoring_scheme = multiple_choice_scoring("plus_minus"))
multipleChoice(choices = c("A", "B", "C"), points = c(0.5, 0, 0.5),
  scoring_scheme = multiple_choice_scoring("exams", rule = "none"))

Create object MultipleChoice

Description

Create object MultipleChoice

Usage

multipleChoice(
  identifier = generate_id(),
  title = identifier,
  choices,
  choice_identifiers = paste0("Choice", LETTERS[seq(choices)]),
  content = list(),
  prompt = "",
  points = 1,
  feedback = list(),
  orientation = "vertical",
  shuffle = TRUE,
  calculator = NA_character_,
  files = NA_character_,
  scoring_scheme = "standard"
)

Arguments

Value

An object of class MultipleChoice

Examples

mc_min <- multipleChoice(choices = c("option1", "option2", "option3"),
                        points = c(0, 0.5, 0.5))

mc <- multipleChoice(identifier = "id_task_1234",
                   title = "Multiple Choice Task",
                   content = "<p>Pick up the right options</p>",
                   prompt = "Plain text, can be used instead of content",
                   points = c(0, 0.5, 0.5),
                   feedback = list(new("WrongFeedback",
                                   content = list("Wrong answer"))),
                   calculator = "scientific-calculator",
                   files = "text_book.pdf",
                   choices = c("option 1", "option 2", "option 3"),
                   choice_identifiers = c("ChoiceA", "ChoiceB", "ChoiceC"),
                   shuffle = TRUE,
                   orientation = "vertical")

Description

Class MultipleChoice is responsible for creating multiple choice assessment task according to QTI 2.1.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

choices

A character vector defining a set of answer options in the question.

choice_identifiers

A character vector, optional, containing a set of identifiers for answers. By default, identifiers are generated automatically according to the template "ChoiceD", where D is a letter representing the alphabetical order of the answer in the list.

shuffle

A boolean value indicating whether to randomize the order in which the choices are initially presented to the candidate. Default is TRUE.

orientation

A character, determining whether to place answers in vertical or horizontal mode. Possible values:

• "vertical" - Default.

• "horizontal"

scoring_scheme

A method name or named list from multiple_choice_scoring(). Defaults to "standard", preserving the existing weighted mapping.

Examples

mc <- new("MultipleChoice",
          identifier = "id_task_1234",
          title = "Multiple Choice Task",
          content = list("<p>Pick up the right options</p>"),
          prompt = "Plain text, can be used instead of content",
          points = c(1, -1, 1, -1),
          feedback = list(new("WrongFeedback", content = list("Wrong answer"))),
          calculator = "scientific-calculator",
          files = "text_book.pdf",
          choices = c("option 1", "option 2", "option 3", "option 4"),
          choice_identifiers = c("ChoiceA", "ChoiceB", "ChoiceC", "ChoiceD"),
          shuffle = TRUE,
          orientation = "vertical")

Create object MultipleChoiceTable

Description

Create object MultipleChoiceTable

Usage

multipleChoiceTable(
  identifier = generate_id(),
  title = identifier,
  content = list(),
  prompt = "",
  points = 1,
  rows,
  rows_identifiers,
  cols,
  cols_identifiers,
  answers_identifiers,
  answers_scores = NA_real_,
  shuffle = TRUE,
  shuffle_rows = TRUE,
  shuffle_cols = TRUE,
  feedback = list(),
  calculator = NA_character_,
  files = NA_character_
)

Arguments

Value

An object of class MultipleChoiceTable

Examples

mt_min <- multipleChoiceTable(content = "<p>\"Multiple choice table\" task</p>",
                       rows = c("alfa", "beta", "gamma", "alpha"),
                       rows_identifiers = c("a", "b", "g", "aa"),
                       cols = c("A", "B", "G", "a"),
                       cols_identifiers = c("as", "bs", "gs", "aas"),
                       answers_identifiers = c("a as", "b bs", "g gs", "aa as", "a aas", "aa aas"))

mt <- multipleChoiceTable(identifier = "id_task_1234",
                   title = "Table with many possible answers in rows and cols",
                   content = "<p>\"Multiple choice table\" task</p>",
                   prompt = "Plain text, can be used instead of the content",
                   rows = c("alfa", "beta", "gamma", "alpha"),
                   rows_identifiers = c("a", "b", "g", "aa"),
                   cols = c("A", "B", "G", "a"),
                   cols_identifiers = c("as", "bs", "gs", "aas"),
                   answers_identifiers = c("a as", "b bs", "g gs", "aa as", "a aas", "aa aas"),
                   answers_scores = c(1, 0.5, 0.1, 1, 0.5, 1),
                   shuffle_rows = FALSE,
                   shuffle_cols = TRUE)

Description

Class MultipleChoiceTable is responsible for creating assessment tasks according to the QTI 2.1 standard with a table of answer options, where many correct answers in each row and column are possible.

Slots

identifier

A character representing the unique identifier of the assessment task. By default, it is generated as 'id_task_dddd', where dddd represents random digits.

title

A character representing the title of the XML file associated with the task. By default, it takes the value of the identifier.

content

A list of character content to form the text of the question, which can include HTML tags. For tasks of the Entry type, it must also contain at least one instance of Gap objects, such as TextGap, TextGapOpal, NumericGap, or InlineChoice.

prompt

An optional character representing a simple question text, consisting of one paragraph. This can supplement or replace content in the task. Default is "".

points

A numeric value, optional, representing the number of points for the entire task. Default is 1, but pay attention:

• For tasks of the Entry type, it is calculated as the sum of the gap points by default.

• For tasks of the DirectedPair, the default is calculated as 0.5 points per pair.

• For tasks of the MatchTable type, it can also be calculated as the sum of points for individual answers, when provided.

• For tasks of the MultipleChoice type, points is numeric vector and required. Each number in this vector determines the number of points that will be awarded to a candidate if they select the corresponding answer. The order of the scores must match the order of the choices. It is possible to assign negative values to incorrect answers. All answers with a positive score are considered correct.

feedback

A list containing feedback messages for candidates. Each element of the list should be an instance of either ModalFeedback, CorrectFeedback, or WrongFeedback class.

calculator

A character, optional, determining whether to show a calculator to the candidate. Possible values:

• "simple"

• "scientific"

files

A character vector, optional, containing paths to files that will be accessible to the candidate during the test/exam.

metadata

An object of class QtiMetadata that holds metadata information about the task.

stylesheet_path

Optional character vector of local CSS file paths. Stylesheets are linked from the item and included in QTI exports. In Rmd YAML, relative paths are resolved against the Rmd file's directory.

css

Optional single character string of CSS text, linked after any files in stylesheet_path. In Rmd YAML, use a literal block (⁠css: |⁠). CSS assets referenced by url() or ⁠@import⁠ are not bundled automatically.

rows

A character vector specifying answer options as row names in the table or the first elements in couples in DirectedPair.

rows_identifiers

A character vector, optional, specifying identifiers for answer options defined in rows of the table or identifiers of the first elements in couples in DirectedPair.

cols

A character vector specifying answer options as column headers in the table or the second elements in couples in DirectedPair.

cols_identifiers

A character vector, optional, specifying identifiers for answer options defined in columns of the table or identifiers of the second elements in couples in DirectedPair.

answers_identifiers

A character vector specifying couples of identifiers that combine the correct answers.

answers_scores

A numeric vector, optional, where each number determines the number of points awarded to a candidate if they select the corresponding answer. If not assigned, the individual values for correct answers are calculated from the task points and the number of correct options.

shuffle

A boolean value, optional, determining whether to randomize the order in which the choices are initially presented to the candidate. Default is TRUE.

shuffle_rows

A boolean value, optional, determining whether to randomize the order of the choices only in rows. Default is TRUE.

shuffle_cols

A boolean value, optional, determining whether to randomize the order of the choices only in columns. Default is TRUE.

mapping

Do not use directly; values are initialized automatically. This slot contains a named numeric vector of points, where names correspond to all possible combinations of row and column identifiers.

Examples

mt <- new("MultipleChoiceTable",
          identifier = "id_task_1234",
          title = "Multiple choice table",
          content = list("<p>Match table task</p>",
                         "<i>table description</i>"),
          points = 5,
          rows = c("row1", "row2", "row3"),
          rows_identifiers = c("a", "b", "c"),
          cols = c("alfa", "beta", "gamma"),
          cols_identifiers = c("a", "b", "c"),
          answers_identifiers = c("a a", "b b", "b c"),
          shuffle = TRUE)