formatTest: Format a MTurk qualification test
In RydenButler/labelR: Pairwise Data Labeling with Amazon's Mechanical Turk

View source: R/formatTest.R

formatTest

R Documentation

Format a MTurk qualification test

Description

formatTest formats the XML code required to make a MTurk qualification test.

Usage

formatTest(
  title,
  instruction_overview,
  instruction_list,
  question_prompt,
  practice_overview,
  practice_questions,
  practice_image = FALSE,
  test_overview,
  test_questions,
  test_image = FALSE,
  closing_message,
  save_files = TRUE
)

Arguments

`title`	A string containing the title of the qualification test, as it appears within the test.
`instruction_overview`	A string providing general instructions for the HITs
`instruction_list`	A nested list of strings containing bulleted instructions and examples. Each element of the list object corresponds to a separate bullet in the list of instructions. Nesting list objects within one another will allow for nested bullets.
`question_prompt`	A string containing the common question prompt used across all pairwise comparison questions.
`practice_overview`	A string providing general instructions for the practice questions within the qualification test. This should inform workers how practice questions differ from other questions in the test and/or HITs on MTurk.
`practice_questions`	A list of lists where each element of the main list contains a single list for each unique practice question. Each question-specific list contains three elements, where the first and second element contain the left and right comparison text, respectively, and the third element contains text explaining the correct answer.
`practice_image`	A logical. When TRUE the `practice_questions` inputs will be treated as images for formatting purposes.
`test_overview`	A string providing general instructions for the test questions within the qualification test. This should contain information about scoring procedures.
`test_questions`	A list of lists where each element of the main list contains a single list for each unique practice question. Each question-specific list contains three elements, where the first and second element contain the left and right comparison text, respectively, and the third element contains an integer corresponding to the index of the correct choice.
`test_image`	A logical. When TRUE the `test_questions` inputs will be treated as images for formatting purposes.
`closing_message`	A string containing the final text presented in the training module. This should contain warnings about worker monitoring and/or rate limiting procedures.
`save_files`	A logical indicating whether the .xml files for the qualification test and answer key should be saved to the working directory.

Details

The function writes generic .xml files required to make an MTurk qualification test. Though the function is designed for users to pass strings directly into the arguments, the arguments also accept HTML-formatted text.

Value

A list of XML formatted strings that specify the qualification test and answer key. By default, each is written as a .xml file in the working directory for users to make manual revisions.