MTurkR (version 0.4)

CreateQualificationType: Create QualificationType

Description

Create a QualificationType. This creates a QualificationType, but does not assign it to any workers. All characteristics of the QualificationType (except name and keywords) can be changed later with UpdateQualificationType.

Usage

CreateQualificationType(name, description, status, keywords = NULL, 
                        retry.delay = NULL, test = NULL, answerkey = NULL, 
                        test.duration = NULL,
                        validate.test = FALSE, validate.answerkey = FALSE,
                        auto = NULL, auto.value = NULL, keypair = credentials(),
                        print = getOption('MTurkR.print'),
                        browser = getOption('MTurkR.browser'),
                        log.requests = getOption('MTurkR.log'),
                        sandbox = getOption('MTurkR.sandbox'),
                        validation.test = getOption('MTurkR.test'))

Arguments

name

A name for the QualificationType. This is visible to workers. It cannot be modified by UpdateQualificationType.

description

A longer description of the QualificationType. This is visible to workers. Maximum of 2000 characters.

status

A character vector of Active or Inactive, indicating whether the QualificationType should be active and visible.

keywords

An optional character string containing a comma-separated set of keywords by which workers can search for the QualificationType. Maximum 1000 characters. These cannot be modified by UpdateQualification

retry.delay

An optional time (in seconds) indicating how long workers have to wait before requesting the QualificationType after an initial rejection.

test

An optional character string consisting of a QuestionForm data structure, used as a test a worker must complete before the QualificationType is granted to them.

answerkey

An optional character string consisting of an AnswerKey data structure, used to automatically score the test, perhaps as returned by GenerateAnswerKey.

test.duration

An optional time (in seconds) indicating how long workers have to complete the test.

validate.test

A logical specifying whether the test parameter should be validated against the relevant MTurk schema prior to creating the QualificationType (operation will fail if it does not validate, and will return validation information). Default is

validate.answerkey

A logical specifying whether the answerkey parameter should be validated against the relevant MTurk schema prior to creating the QualificationType (operation will fail if it does not validate, and will return validation information). Default

auto

A logical indicating whether the Qualification is automatically granted to workers who request it. Default is FALSE.

auto.value

An optional parameter specifying the value that is automatically assigned to workers when they request it (if the Qualification is automatically granted).

keypair

A two-item character vector containing an AWS Access Key ID in the first position and the corresponding Secret Access Key in the second position. Set default with credentials.

print

Optionally print the results of the API request to the standard output. Default is TRUE.

browser

Optionally open the request in the default web browser, rather than opening in R. Default is FALSE.

log.requests

A logical specifying whether API requests should be logged. Default is TRUE. See readlogfile for details.

sandbox

Optionally execute the request in the MTurk sandbox rather than the live server. Default is FALSE.

validation.test

A logical specifying whether only the pre-request checks should be conducted and the request URL returned (without executing the request). Default is FALSE.

Value

• A dataframe containing the QualificationTypeId of the newly created QualificationType and other details as specified in the request.

Details

A function to create a QualificationType. Active QualificationTypes are visible to workers and to other requesters. All characteristics of the QualificationType, other than the name and keywords, can later be modified by UpdateQualificationType. Qualifications can then be used to assign Qualifications to workers with AssignQualification and invoked as QualificationRequirements in RegisterHITType and/or CreateHIT operations. Note that when browser=TRUE, specifying this operation with test (and, optionally, answer) parameters may produce unintended behavior due to constraints on the length of the URL imposed by some web browsers. createqual() is an alias.

References

http://docs.amazonwebservices.com/AWSMechTurk/latest/AWSMturkAPI/ApiReference_CreateQualificationTypeOperation.html{API Reference}

See Also

GetQualificationType DisposeQualificationType UpdateQualificationType SearchQualificationTypes

Examples

qual1 <- CreateQualificationType(name="Worked for me before",
        description="This qualification is for people who have worked for me before",
        keywords="Worked for me before",sandbox=TRUE)
qual1