UpdateQualificationType: Update a Worker QualificationType

In cloudyr/MTurkR: R Client for the MTurk Requester API

Description

Update characteristics of a QualificationType.

Usage

UpdateQualificationType(qual, description = NULL, status = NULL, 
                        retry.delay = NULL, test = NULL, answerkey = NULL, 
                        test.duration = NULL,
                        validate.test = FALSE, validate.answerkey = FALSE,
                        auto = NULL, auto.value = NULL, 
                        verbose = getOption('MTurkR.verbose', TRUE), ...)

Arguments

qual	A character string containing a QualificationTypeId.
description	A character string describing the Qualification. 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.
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. If a previous test with an associated AnswerKey is updated, the new test will not have an AnswerKey unless a new one is included in the same call (even if it is identical to the previous AnswerKey).
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 FALSE.
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 is FALSE.
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).
verbose	Optionally print the results of the API request to the standard output. Default is taken from getOption('MTurkR.verbose', TRUE).
...	Additional arguments passed to request.

Details

A function to update the characteristics of a QualificationType. Name and keywords cannot be modified after a QualificationType is created.

updatequal() is an alias.

Value

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

Author(s)

Thomas J. Leeper

References

API Reference

See Also

GetQualificationType

CreateQualificationType

DisposeQualificationType

SearchQualificationTypes

Examples

## Not run: 
qual1 <- 
CreateQualificationType(name="Worked for me before",
    description="This qualification is for people who have worked for me before",
    status = "Active",
    keywords="Worked for me before")
qual2 <- 
UpdateQualificationType(qual1$QualificationTypeId,
    description="This qualification is for everybody!",
    auto=TRUE, auto.value="5")
DisposeQualificationType(qual1$QualificationTypeId)

## End(Not run)

cloudyr/MTurkR documentation built on June 4, 2019, 3:30 p.m.